tca_client 1.0.0 → 1.0.2

data/lib/tca_client/configuration.rb

@@ -3,10 +3,11 @@
 
 #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
 
 module TCAClient
@@ -20,6 +21,18 @@ module TCAClient
     # Defines url base path
     attr_accessor :base_path
 
+    # Define server configuration index
+    attr_accessor :server_index
+
+    # Define server operation configuration index
+    attr_accessor :server_operation_index
+
+    # Default server variables
+    attr_accessor :server_variables
+
+    # Default server operation variables
+    attr_accessor :server_operation_variables
+
     # Defines API keys used with API Key authentications.
     #
     # @return [Hash] key: parameter name, value: parameter value (API key)
@@ -120,23 +133,28 @@ module TCAClient
     # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
     attr_accessor :params_encoding
 
+
     attr_accessor :inject_format
 
     attr_accessor :force_ending_format
 
     def initialize
       @scheme = 'https'
-      @host = '{tenantName}.{hostName}'
-      @base_path = 'https://{tenantName}.{hostName}/api/v1'
+      @host = 'app-us.turnitin.com'
+      @base_path = '/api/v1'
+      @server_index = 0
+      @server_operation_index = {}
+      @server_variables = {}
+      @server_operation_variables = {}
       @api_key = {}
       @api_key_prefix = {}
-      @timeout = 0
       @client_side_validation = true
       @verify_ssl = true
       @verify_ssl_host = true
-      @params_encoding = nil
       @cert_file = nil
       @key_file = nil
+      @timeout = 0
+      @params_encoding = nil
       @debugging = false
       @inject_format = false
       @force_ending_format = false
@@ -170,17 +188,23 @@ module TCAClient
       @base_path = '' if @base_path == '/'
     end
 
-    def base_url
-      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+    # Returns base URL for specified operation based on server settings
+    def base_url(operation = nil)
+      index = server_operation_index.fetch(operation, server_index)
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
+
+      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
     end
 
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name)
+    def api_key_with_prefix(param_name, param_alias = nil)
+      key = @api_key[param_name]
+      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
       if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+        "#{@api_key_prefix[param_name]} #{key}"
       else
-        @api_key[param_name]
+        key
       end
     end
 
@@ -197,9 +221,65 @@ module TCAClient
             type: 'api_key',
             in: 'header',
             key: 'Authorization',
-            value: api_key_with_prefix('Authorization')
+            value: api_key_with_prefix('api_key')
           },
       }
     end
+
+    # Returns an array of Server setting
+    def server_settings
+      [
+        {
+          url: "https://{tenantName}.turnitin.com/api/v1",
+          description: "No description provided",
+          variables: {
+            tenantName: {
+                description: "Customer tenant name",
+                default_value: "app-us",
+              }
+            }
+        }
+      ]
+    end
+
+    def operation_server_settings
+      {
+      }
+    end
+
+    # Returns URL based on server settings
+    #
+    # @param index array index of the server settings
+    # @param variables hash of variable and the corresponding value
+    def server_url(index, variables = {}, servers = nil)
+      servers = server_settings if servers == nil
+
+      # check array index out of bound
+      if (index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      end
+
+      server = servers[index]
+      url = server[:url]
+
+      return url unless server.key? :variables
+
+      # go through variable and assign a value
+      server[:variables].each do |name, variable|
+        if variables.key?(name)
+          if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
+            url.gsub! "{" + name.to_s + "}", variables[name]
+          else
+            fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
+          end
+        else
+          # use default value
+          url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+        end
+      end
+
+      url
+    end
+
   end
 end

data/lib/tca_client/models/add_group_attachment_request.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
   # Request Object to add group attachment.
@@ -28,11 +30,16 @@ 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
       {
-        :'title' => :'Object',
-        :'template' => :'Object'
+        :'title' => :'String',
+        :'template' => :'Boolean'
       }
     end
 
@@ -41,7 +48,7 @@ module TCAClient
       Set.new([
       ])
     end
-  
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -72,15 +79,39 @@ module TCAClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      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 !@title.nil? && @title.to_s.length < 1
+        invalid_properties.push('invalid value for "title", the character length must be great than or equal to 1.')
+      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 !@title.nil? && @title.to_s.length > 500
+      return false if !@title.nil? && @title.to_s.length < 1
       true
     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
+
+      if !title.nil? && title.to_s.length < 1
+        fail ArgumentError, 'invalid value for "title", the character length must be great than or equal to 1.'
+      end
+
+      @title = title
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -114,8 +145,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)
@@ -123,8 +157,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
 
@@ -137,8 +169,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
@@ -168,7 +200,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
 
@@ -216,5 +250,8 @@ module TCAClient
       else
         value
       end
-    end  end
+    end
+
+  end
+
 end

data/lib/tca_client/models/add_group_attachment_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
   # Object returned for add group attachment.
@@ -24,10 +26,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
       {
-        :'id' => :'Object'
+        :'id' => :'String'
       }
     end
 
@@ -36,7 +43,7 @@ module TCAClient
       Set.new([
       ])
     end
-  
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -102,8 +109,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)
@@ -111,8 +121,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
 
@@ -125,8 +133,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
@@ -156,7 +164,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
 
@@ -204,5 +214,8 @@ module TCAClient
       else
         value
       end
-    end  end
+    end
+
+  end
+
 end

data/lib/tca_client/models/aggregate_group.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 AggregateGroup
@@ -61,15 +63,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
       {
-        :'id' => :'Object',
-        :'name' => :'Object',
-        :'type' => :'Object',
-        :'group_context' => :'Object',
-        :'due_date' => :'Object',
-        :'report_generation' => :'Object'
+        :'id' => :'String',
+        :'name' => :'String',
+        :'type' => :'String',
+        :'group_context' => :'GroupContext',
+        :'due_date' => :'Date',
+        :'report_generation' => :'String'
       }
     end
 
@@ -78,7 +85,7 @@ module TCAClient
       Set.new([
       ])
     end
-  
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -129,9 +136,9 @@ module TCAClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      type_validator = EnumAttributeValidator.new('Object', ['ASSIGNMENT', 'FOLDER'])
+      type_validator = EnumAttributeValidator.new('String', ["ASSIGNMENT", "FOLDER"])
       return false unless type_validator.valid?(@type)
-      report_generation_validator = EnumAttributeValidator.new('Object', ['IMMEDIATELY', 'IMMEDIATELY_AND_DUE_DATE'])
+      report_generation_validator = EnumAttributeValidator.new('String', ["IMMEDIATELY", "IMMEDIATELY_AND_DUE_DATE"])
       return false unless report_generation_validator.valid?(@report_generation)
       true
     end
@@ -139,7 +146,7 @@ module TCAClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('Object', ['ASSIGNMENT', 'FOLDER'])
+      validator = EnumAttributeValidator.new('String', ["ASSIGNMENT", "FOLDER"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -149,7 +156,7 @@ module TCAClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] report_generation Object to be assigned
     def report_generation=(report_generation)
-      validator = EnumAttributeValidator.new('Object', ['IMMEDIATELY', 'IMMEDIATELY_AND_DUE_DATE'])
+      validator = EnumAttributeValidator.new('String', ["IMMEDIATELY", "IMMEDIATELY_AND_DUE_DATE"])
       unless validator.valid?(report_generation)
         fail ArgumentError, "invalid value for \"report_generation\", must be one of #{validator.allowable_values}."
       end
@@ -193,8 +200,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)
@@ -202,8 +212,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
 
@@ -216,8 +224,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
@@ -247,7 +255,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
 
@@ -295,5 +305,8 @@ module TCAClient
       else
         value
       end
-    end  end
+    end
+
+  end
+
 end