tca_client 1.0.0 → 1.0.1

data/lib/tca_client/models/submission_base.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
   # A Submission is the base object on which other services (such as similarity) are offered. In order to use other services a Submission must first be created and successfully process, then other service objects can be created. 
@@ -76,27 +78,33 @@ 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
       {
         :'id' => :'Object',
-        :'owner' => :'Object',
-        :'owner_default_permission_set' => :'Object',
-        :'title' => :'Object',
-        :'submitter' => :'Object',
-        :'submitter_default_permission_set' => :'Object',
-        :'eula' => :'Object',
-        :'metadata' => :'Object',
-        :'extract_text_only' => :'Object'
+        :'owner' => :'String',
+        :'owner_default_permission_set' => :'String',
+        :'title' => :'String',
+        :'submitter' => :'String',
+        :'submitter_default_permission_set' => :'String',
+        :'eula' => :'Eula',
+        :'metadata' => :'SubmissionBaseMetadata',
+        :'extract_text_only' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'id',
       ])
     end
-  
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -153,33 +161,78 @@ module TCAClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@owner.nil? && @owner.to_s.length > 132
+        invalid_properties.push('invalid value for "owner", the character length must be smaller than or equal to 132.')
+      end
+
+      if !@title.nil? && @title.to_s.length > 500
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 500.')
+      end
+
+      if !@submitter.nil? && @submitter.to_s.length > 132
+        invalid_properties.push('invalid value for "submitter", the character length must be smaller than or equal to 132.')
+      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?
-      owner_default_permission_set_validator = EnumAttributeValidator.new('Object', ['INSTRUCTOR', 'LEARNER', 'EDITOR', 'USER', 'APPLICANT', 'ADMINISTRATOR', 'UNDEFINED'])
+      return false if !@owner.nil? && @owner.to_s.length > 132
+      owner_default_permission_set_validator = EnumAttributeValidator.new('String', ["INSTRUCTOR", "LEARNER", "EDITOR", "USER", "APPLICANT", "ADMINISTRATOR", "UNDEFINED"])
       return false unless owner_default_permission_set_validator.valid?(@owner_default_permission_set)
-      submitter_default_permission_set_validator = EnumAttributeValidator.new('Object', ['INSTRUCTOR', 'LEARNER', 'EDITOR', 'USER', 'APPLICANT', 'ADMINISTRATOR', 'UNDEFINED'])
+      return false if !@title.nil? && @title.to_s.length > 500
+      return false if !@submitter.nil? && @submitter.to_s.length > 132
+      submitter_default_permission_set_validator = EnumAttributeValidator.new('String', ["INSTRUCTOR", "LEARNER", "EDITOR", "USER", "APPLICANT", "ADMINISTRATOR", "UNDEFINED"])
       return false unless submitter_default_permission_set_validator.valid?(@submitter_default_permission_set)
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] owner Value to be assigned
+    def owner=(owner)
+      if !owner.nil? && owner.to_s.length > 132
+        fail ArgumentError, 'invalid value for "owner", the character length must be smaller than or equal to 132.'
+      end
+
+      @owner = owner
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] owner_default_permission_set Object to be assigned
     def owner_default_permission_set=(owner_default_permission_set)
-      validator = EnumAttributeValidator.new('Object', ['INSTRUCTOR', 'LEARNER', 'EDITOR', 'USER', 'APPLICANT', 'ADMINISTRATOR', 'UNDEFINED'])
+      validator = EnumAttributeValidator.new('String', ["INSTRUCTOR", "LEARNER", "EDITOR", "USER", "APPLICANT", "ADMINISTRATOR", "UNDEFINED"])
       unless validator.valid?(owner_default_permission_set)
         fail ArgumentError, "invalid value for \"owner_default_permission_set\", must be one of #{validator.allowable_values}."
       end
       @owner_default_permission_set = owner_default_permission_set
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if !title.nil? && title.to_s.length > 500
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 500.'
+      end
+
+      @title = title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] submitter Value to be assigned
+    def submitter=(submitter)
+      if !submitter.nil? && submitter.to_s.length > 132
+        fail ArgumentError, 'invalid value for "submitter", the character length must be smaller than or equal to 132.'
+      end
+
+      @submitter = submitter
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] submitter_default_permission_set Object to be assigned
     def submitter_default_permission_set=(submitter_default_permission_set)
-      validator = EnumAttributeValidator.new('Object', ['INSTRUCTOR', 'LEARNER', 'EDITOR', 'USER', 'APPLICANT', 'ADMINISTRATOR', 'UNDEFINED'])
+      validator = EnumAttributeValidator.new('String', ["INSTRUCTOR", "LEARNER", "EDITOR", "USER", "APPLICANT", "ADMINISTRATOR", "UNDEFINED"])
       unless validator.valid?(submitter_default_permission_set)
         fail ArgumentError, "invalid value for \"submitter_default_permission_set\", must be one of #{validator.allowable_values}."
       end
@@ -226,8 +279,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)
@@ -235,8 +291,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
 
@@ -249,8 +303,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
@@ -280,7 +334,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
 
@@ -328,5 +384,8 @@ module TCAClient
       else
         value
       end
-    end  end
+    end
+
+  end
+
 end

data/lib/tca_client/models/submission_base_metadata.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
   # (optional) Submission metadata. If a group context is included, it must be associated to a group
@@ -40,15 +42,20 @@ 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
       {
-        :'submitter' => :'Object',
-        :'owners' => :'Object',
-        :'group' => :'Object',
-        :'group_context' => :'Object',
-        :'original_submitted_time' => :'Object',
-        :'custom' => :'Object'
+        :'submitter' => :'Users',
+        :'owners' => :'Array<Users>',
+        :'group' => :'Group',
+        :'group_context' => :'GroupContext',
+        :'original_submitted_time' => :'Time',
+        :'custom' => :'String'
       }
     end
 
@@ -57,7 +64,7 @@ module TCAClient
       Set.new([
       ])
     end
-  
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -150,8 +157,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)
@@ -159,8 +169,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
 
@@ -173,8 +181,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
@@ -204,7 +212,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
 
@@ -252,5 +262,8 @@ module TCAClient
       else
         value
       end
-    end  end
+    end
+
+  end
+
 end