class Copyleaks::SubmissionProperties
Attributes
Public Class Methods
@param [SubmissionWebhooks] webhooks - Check inner properties for more details. @param [Boolean] includeHtml - By default, Copyleaks
will present the report in text format. If set to true, Copyleaks
will also include html format. @param [String] developerPayload - Add custom developer payload that will then be provided on the webhooks. api.copyleaks.com/documentation/v3/webhooks @param [Boolean] sandbox - You can test the integration with the Copyleaks
API
for free using the sandbox mode. You will be able to submit content for a scan and get back mock results, simulating the way Copyleaks
will work to make sure that you successfully integrated with the API
. Turn off this feature on production environment. @param [Integer] expiration - Specify the maximum life span of a scan in hours on the Copyleaks
servers. When expired, the scan will be deleted and will no longer be accessible. @param [Integer] sensitivityLevel - You can control the level of plagiarism sensitivity that will be identified according to the speed of the scan. If you prefer a faster scan with the results that contains the highest amount of plagiarism choose 1, and if a slower, more comprehensive scan, that will also detect the smallest instances choose 5. @param [Boolean] cheatDetection - When set to true the submitted document will be checked for cheating. If a cheating will be detected, a scan alert will be added to the completed webhook. @param [SubmissionActions] action - Types of content submission actions. Possible values: Scan: Start scan immediately. Check Credits: Check how many credits will be used for this scan. Index Only: Only index the file in the Copyleaks
internal database. No credits will be used. @param [SubmissionAuthor] author - Check inner properties for more details. @param [SubmissionFilter] filters - Check inner properties for more details. @param [SubmissionScanning] scanning - Check inner properties for more details. @param [SubmissionIndexing] indexing - Check inner properties for more details. @param [SubmissionExclude] exclude - Check inner properties for more details. @param [SubmissionPDF] pdf - Check inner properties for more details. @param [SubmissionSensitiveData] sensitiveDataProtection - Check inner properties for more details. @param [SubmissionScanMethodAlgorithm] scanMethodAlgorithm - Check inner properties for more details. @param [SubmissionAiGeneratedText] aiGeneratedText - Check inner properties for more details. @param [SubmissionCustomMetadata] customMetadata - Add custom properties that will be attached to your document in a Copyleaks
repository.
# File lib/copyleaks/models/submissions/properties/submission_properties.rb, line 48 def initialize( webhooks, includeHtml = nil, developerPayload = nil, sandbox = nil, expiration = nil, sensitivityLevel = nil, cheatDetection = nil, action = nil, author = nil, filters = nil, scanning = nil, indexing = nil, exclude = nil, pdf = nil, sensitiveDataProtection = nil, scanMethodAlgorithm = nil, aiGeneratedText = nil, customMetadata = nil ) unless webhooks.instance_of?(SubmissionWebhooks) raise 'Copyleaks::SubmissionProperties - webhooks - webhooks must be of type SubmissionWebhooks' end if !includeHtml.nil? && ![true, false].include?(includeHtml) raise 'Copyleaks::SubmissionProperties - includeHtml - includeHtml must be of type Boolean' end unless developerPayload.instance_of?(String) raise 'Copyleaks::SubmissionProperties - developerPayload - developerPayload must be of type String' end if !sandbox.nil? && ![true, false].include?(sandbox) raise 'Copyleaks::SubmissionProperties - sandbox - includeHtml must be of type Boolean' end unless expiration.instance_of?(Integer) raise 'Copyleaks::SubmissionProperties - expiration - expiration must be of type Integer' end unless sensitivityLevel.instance_of?(Integer) raise 'Copyleaks::SubmissionProperties - sensitivityLevel - sensitivityLevel must be of type Integer' end if !cheatDetection.nil? && ![true, false].include?(cheatDetection) raise 'Copyleaks::SubmissionProperties - cheatDetection - cheatDetection must be of type Boolean' end if !action.nil? && ![0, 1, 2].include?(action) raise 'Copyleaks::SubmissionProperties - action - action must be of type SubmissionActions consts' end if !author.nil? && !author.instance_of?(SubmissionAuthor) raise 'Copyleaks::SubmissionProperties - author - author must be of type SubmissionAuthor' end if !filters.nil? && !filters.instance_of?(SubmissionFilter) raise 'Copyleaks::SubmissionProperties - filters - filters must be of type SubmissionFilter' end if !scanning.nil? && !scanning.instance_of?(SubmissionScanning) raise 'Copyleaks::SubmissionProperties - scanning - scanning must be of type SubmissionScanning' end if !indexing.nil? && !indexing.instance_of?(SubmissionIndexing) raise 'Copyleaks::SubmissionProperties - indexing - indexing must be of type SubmissionIndexing' end if !exclude.nil? && !exclude.instance_of?(SubmissionExclude) raise 'Copyleaks::SubmissionProperties - exclude - exclude must be of type SubmissionExclude' end if !pdf.nil? && !pdf.instance_of?(SubmissionPDF) raise 'Copyleaks::SubmissionProperties - pdf - pdf must be of type SubmissionPDF' end if !sensitiveDataProtection.nil? && !sensitiveDataProtection.instance_of?(SubmissionSensitiveData) raise 'Copyleaks::SubmissionProperties - sensitiveDataProtection - sensitiveDataProtection must be of type SubmissionSensitiveData' end if !scanMethodAlgorithm.nil? && ![0, 1].include?(scanMethodAlgorithm) raise 'Copyleaks::SubmissionProperties - scanMethodAlgorithm - scanMethodAlgorithm must be of type SubmissionScanMethodAlgorithm' end if !aiGeneratedText.nil? && !aiGeneratedText.instance_of?(SubmissionAiGeneratedText) raise 'Copyleaks::SubmissionProperties - aiGeneratedText - aiGeneratedText must be of type SubmissionAiGeneratedText' end if !customMetadata.nil? && !(customMetadata.is_a?(Array) && customMetadata.all? { |element| element.is_a?(SubmissionCustomMetadata) }) raise 'Copyleaks::SubmissionProperties - customMetadata - customMetadata must be of type SubmissionCustomMetadata[]' end @webhooks = webhooks @includeHtml = includeHtml @developerPayload = developerPayload @sandbox = sandbox @expiration = expiration @sensitivityLevel = sensitivityLevel @cheatDetection = cheatDetection @aiGeneratedText = aiGeneratedText @action = action @author = author @filters = filters @scanning = scanning @indexing = indexing @exclude = exclude @pdf = pdf @sensitiveDataProtection = sensitiveDataProtection @scanMethodAlgorithm = scanMethodAlgorithm @customMetadata = customMetadata end
Public Instance Methods
# File lib/copyleaks/models/submissions/properties/submission_properties.rb, line 129 def as_json(*_args) { webhooks: @webhooks, includeHtml: @includeHtml, developerPayload: @developerPayload, sandbox: @sandbox, expiration: @expiration, sensitivityLevel: @sensitivityLevel, cheatDetection: @cheatDetection, aiGeneratedText: @aiGeneratedText, action: @action, author: @author, filters: @filters, scanning: @scanning, indexing: @indexing, exclude: @exclude, pdf: @pdf, sensitiveDataProtection: @sensitiveDataProtection, scanMethodAlgorithm: @scanMethodAlgorithm, customMetadata: @customMetadata }.select { |_k, v| !v.nil? } end
# File lib/copyleaks/models/submissions/properties/submission_properties.rb, line 152 def to_json(*options) as_json(*options).to_json(*options) end