tca_client 1.0.0 → 1.0.2

data/lib/tca_client/models/similarity_viewer_url_response.rb

@@ -3,13 +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 'date'
+require 'time'
 
 module TCAClient
   class SimilarityViewerUrlResponse
@@ -23,10 +25,15 @@ module TCAClient
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'viewer_url' => :'Object'
+        :'viewer_url' => :'String'
       }
     end
 
@@ -35,7 +42,7 @@ module TCAClient
       Set.new([
       ])
     end
-  
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -101,8 +108,11 @@ module TCAClient
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
       self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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)
@@ -110,8 +120,6 @@ module TCAClient
           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
 
@@ -124,8 +132,8 @@ module TCAClient
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -155,7 +163,9 @@ module TCAClient
           end
         end
       else # model
-        TCAClient.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = TCAClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -203,5 +213,8 @@ module TCAClient
       else
         value
       end
-    end  end
+    end
+
+  end
+
 end

data/lib/tca_client/models/similarity_viewer_url_settings.rb

@@ -3,13 +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 'date'
+require 'time'
 
 module TCAClient
   class SimilarityViewerUrlSettings
@@ -32,6 +34,8 @@ module TCAClient
 
     attr_accessor :similarity
 
+    attr_accessor :annotations
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -64,21 +68,28 @@ module TCAClient
         :'viewer_permissions' => :'viewer_permissions',
         :'eula' => :'eula',
         :'sidebar' => :'sidebar',
-        :'similarity' => :'similarity'
+        :'similarity' => :'similarity',
+        :'annotations' => :'annotations'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'author_metadata_override' => :'Object',
-        :'viewer_user_id' => :'Object',
-        :'locale' => :'Object',
-        :'viewer_default_permission_set' => :'Object',
-        :'viewer_permissions' => :'Object',
-        :'eula' => :'Object',
-        :'sidebar' => :'Object',
-        :'similarity' => :'Object'
+        :'author_metadata_override' => :'AuthorMetadataOverride',
+        :'viewer_user_id' => :'String',
+        :'locale' => :'String',
+        :'viewer_default_permission_set' => :'String',
+        :'viewer_permissions' => :'ViewerPermissions',
+        :'eula' => :'Eula',
+        :'sidebar' => :'Sidebar',
+        :'similarity' => :'SimilaritySettings',
+        :'annotations' => :'AnnotationsSettings'
       }
     end
 
@@ -87,7 +98,7 @@ module TCAClient
       Set.new([
       ])
     end
-  
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -134,6 +145,10 @@ module TCAClient
       if attributes.key?(:'similarity')
         self.similarity = attributes[:'similarity']
       end
+
+      if attributes.key?(:'annotations')
+        self.annotations = attributes[:'annotations']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -146,7 +161,7 @@ module TCAClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      locale_validator = EnumAttributeValidator.new('Object', ['ar-SA', 'cs-CZ', 'de-DE', 'el-GR', 'en-US', 'es-MX', 'fi-FI', 'fr-FR', 'it-IT', 'ja-JP', 'ko-KR', 'nl-NL', 'pl-PL', 'pt-BR', 'ro-RO', 'ru-RU', 'sv-SE', 'tr-TR', 'vi-VN', 'zh-CN', 'zh-TW'])
+      locale_validator = EnumAttributeValidator.new('String', ["ar-SA", "cs-CZ", "de-DE", "el-GR", "en-US", "es-MX", "fi-FI", "fr-FR", "it-IT", "ja-JP", "ko-KR", "nl-NL", "pl-PL", "pt-BR", "ro-RO", "ru-RU", "sv-SE", "tr-TR", "vi-VN", "zh-CN", "zh-TW"])
       return false unless locale_validator.valid?(@locale)
       true
     end
@@ -154,7 +169,7 @@ module TCAClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] locale Object to be assigned
     def locale=(locale)
-      validator = EnumAttributeValidator.new('Object', ['ar-SA', 'cs-CZ', 'de-DE', 'el-GR', 'en-US', 'es-MX', 'fi-FI', 'fr-FR', 'it-IT', 'ja-JP', 'ko-KR', 'nl-NL', 'pl-PL', 'pt-BR', 'ro-RO', 'ru-RU', 'sv-SE', 'tr-TR', 'vi-VN', 'zh-CN', 'zh-TW'])
+      validator = EnumAttributeValidator.new('String', ["ar-SA", "cs-CZ", "de-DE", "el-GR", "en-US", "es-MX", "fi-FI", "fr-FR", "it-IT", "ja-JP", "ko-KR", "nl-NL", "pl-PL", "pt-BR", "ro-RO", "ru-RU", "sv-SE", "tr-TR", "vi-VN", "zh-CN", "zh-TW"])
       unless validator.valid?(locale)
         fail ArgumentError, "invalid value for \"locale\", must be one of #{validator.allowable_values}."
       end
@@ -173,7 +188,8 @@ module TCAClient
           viewer_permissions == o.viewer_permissions &&
           eula == o.eula &&
           sidebar == o.sidebar &&
-          similarity == o.similarity
+          similarity == o.similarity &&
+          annotations == o.annotations
     end
 
     # @see the `==` method
@@ -185,7 +201,7 @@ module TCAClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [author_metadata_override, viewer_user_id, locale, viewer_default_permission_set, viewer_permissions, eula, sidebar, similarity].hash
+      [author_metadata_override, viewer_user_id, locale, viewer_default_permission_set, viewer_permissions, eula, sidebar, similarity, annotations].hash
     end
 
     # Builds the object from hash
@@ -200,8 +216,11 @@ module TCAClient
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
       self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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)
@@ -209,8 +228,6 @@ module TCAClient
           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
 
@@ -223,8 +240,8 @@ module TCAClient
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -254,7 +271,9 @@ module TCAClient
           end
         end
       else # model
-        TCAClient.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = TCAClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -302,5 +321,8 @@ module TCAClient
       else
         value
       end
-    end  end
+    end
+
+  end
+
 end

data/lib/tca_client/models/simple_submission_response.rb

@@ -3,25 +3,79 @@
 
 #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 'time'
 
 module TCAClient
   class SimpleSubmissionResponse
+    # the unique ID of the submission
+    attr_accessor :id
+
+    # the owner of the submission
+    attr_accessor :owner
+
+    # the title of the submission
+    attr_accessor :title
+
+    # the current status of the Submission
+    attr_accessor :status
+
+    # RFC3339 timestamp of when this submission was initially created. This is the time at which the POST to /submissions was made. 
+    attr_accessor :created_time
+
+    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
       {
+        :'id' => :'id',
+        :'owner' => :'owner',
+        :'title' => :'title',
+        :'status' => :'status',
+        :'created_time' => :'created_time'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'id' => :'String',
+        :'owner' => :'String',
+        :'title' => :'String',
+        :'status' => :'String',
+        :'created_time' => :'Time'
       }
     end
 
@@ -30,7 +84,14 @@ module TCAClient
       Set.new([
       ])
     end
-  
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'SimpleSubmissionResponseAllOf'
+      ]
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -45,6 +106,26 @@ module TCAClient
         end
         h[k.to_sym] = v
       }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'owner')
+        self.owner = attributes[:'owner']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'created_time')
+        self.created_time = attributes[:'created_time']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -57,14 +138,31 @@ module TCAClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      status_validator = EnumAttributeValidator.new('String', ["CREATED", "PROCESSING", "COMPLETE", "DELETED", "ERROR"])
+      return false unless status_validator.valid?(@status)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["CREATED", "PROCESSING", "COMPLETE", "DELETED", "ERROR"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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
+      self.class == o.class &&
+          id == o.id &&
+          owner == o.owner &&
+          title == o.title &&
+          status == o.status &&
+          created_time == o.created_time
     end
 
     # @see the `==` method
@@ -76,7 +174,7 @@ module TCAClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [].hash
+      [id, owner, title, status, created_time].hash
     end
 
     # Builds the object from hash
@@ -91,8 +189,11 @@ module TCAClient
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
       self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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)
@@ -100,8 +201,6 @@ module TCAClient
           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
 
@@ -114,8 +213,8 @@ module TCAClient
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -145,7 +244,9 @@ module TCAClient
           end
         end
       else # model
-        TCAClient.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = TCAClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -193,5 +294,8 @@ module TCAClient
       else
         value
       end
-    end  end
+    end
+
+  end
+
 end