plagiarism-checker 3.4.0 → 3.6.0

data/lib/copyleaks/models/submissions/webhooks/CompletedWebhook.rb

@@ -0,0 +1,46 @@
+ #The MIT License(MIT)
+ #Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+ #Permission is hereby granted, free of charge, to any person obtaining a copy
+ #of this software and associated documentation files (the "Software"), to deal
+ #in the Software without restriction, including without limitation the rights
+ #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #copies of the Software, and to permit persons to whom the Software is
+ #furnished to do so, subject to the following conditions:
+ #The above copyright notice and this permission notice shall be included in all
+ #copies or substantial portions of the Software.
+ #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+ #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #SOFTWARE.
+ #=
+
+module Copyleaks
+  class CompletedWebhook < StatusWebhook
+    attr_reader :results, :notifications, :scannedDocument
+
+    def initialize(results: nil, notifications: nil, scannedDocument: nil, **args)
+      super(**args)
+      @results = results
+      @notifications = notifications
+      @scannedDocument = scannedDocument
+      @extra_fields = args # Store any additional fields here
+    end
+
+    def as_json(*_args)
+      super.merge(
+        {
+          results: @results.respond_to?(:as_json) ? @results.as_json : @results,
+          notifications: @notifications.respond_to?(:as_json) ? @notifications.as_json : @notifications,
+          scannedDocument: @scannedDocument.respond_to?(:as_json) ? @scannedDocument.as_json : @scannedDocument
+        }
+      ).merge(@extra_fields)
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/CreditsCheckedWebhook.rb

@@ -0,0 +1,43 @@
+ #The MIT License(MIT)
+ #Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+ #Permission is hereby granted, free of charge, to any person obtaining a copy
+ #of this software and associated documentation files (the "Software"), to deal
+ #in the Software without restriction, including without limitation the rights
+ #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #copies of the Software, and to permit persons to whom the Software is
+ #furnished to do so, subject to the following conditions:
+ #The above copyright notice and this permission notice shall be included in all
+ #copies or substantial portions of the Software.
+ #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+ #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #SOFTWARE.
+ #=
+
+module Copyleaks
+  class CreditsCheckedWebhook < StatusWebhook
+    attr_reader :credits, :scannedDocument
+
+    def initialize(credits: nil, scannedDocument: nil, **args)
+      super(**args)
+      @credits = credits
+      @scannedDocument = scannedDocument
+    end
+
+    def as_json(*_args)
+      super.merge(
+        {
+          credits: @credits,
+          scannedDocument: @scannedDocument.respond_to?(:as_json) ? @scannedDocument.as_json : @scannedDocument
+        }
+      )
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/ErrorWebhook.rb

@@ -0,0 +1,41 @@
+ #The MIT License(MIT)
+ #Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+ #Permission is hereby granted, free of charge, to any person obtaining a copy
+ #of this software and associated documentation files (the "Software"), to deal
+ #in the Software without restriction, including without limitation the rights
+ #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #copies of the Software, and to permit persons to whom the Software is
+ #furnished to do so, subject to the following conditions:
+ #The above copyright notice and this permission notice shall be included in all
+ #copies or substantial portions of the Software.
+ #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+ #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #SOFTWARE.
+ #=
+
+module Copyleaks
+  class ErrorWebhook < StatusWebhook
+    attr_reader :error
+
+    def initialize(error: nil, **args)
+      super(**args)
+      @error = error
+    end
+
+    def as_json(*_args)
+      super.merge(
+        {
+          error: @error.respond_to?(:as_json) ? @error.as_json : @error
+        }
+      )
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/ExportCompletedWebhook.rb

@@ -0,0 +1,44 @@
+ #The MIT License(MIT)
+ #Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+ #Permission is hereby granted, free of charge, to any person obtaining a copy
+ #of this software and associated documentation files (the "Software"), to deal
+ #in the Software without restriction, including without limitation the rights
+ #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #copies of the Software, and to permit persons to whom the Software is
+ #furnished to do so, subject to the following conditions:
+ #The above copyright notice and this permission notice shall be included in all
+ #copies or substantial portions of the Software.
+ #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+ #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #SOFTWARE.
+ #=
+
+module Copyleaks
+  class ExportCompletedWebhook < Webhook
+    attr_reader :completed, :tasks
+
+    def initialize(completed: nil, tasks: nil, **args)
+      super(**args)
+      @completed = completed
+      @tasks = tasks
+    end
+
+    def as_json(*_args)
+      super.merge(
+        {
+          completed: @completed,
+          tasks: @tasks.respond_to?(:map) ? @tasks.map { |t| t.respond_to?(:as_json) ? t.as_json : t } : @tasks
+        }
+      )
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end
+

data/lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb

@@ -0,0 +1,89 @@
+
+ #The MIT License(MIT)
+ #Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+ #Permission is hereby granted, free of charge, to any person obtaining a copy
+ #of this software and associated documentation files (the "Software"), to deal
+ #in the Software without restriction, including without limitation the rights
+ #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #copies of the Software, and to permit persons to whom the Software is
+ #furnished to do so, subject to the following conditions:
+ #The above copyright notice and this permission notice shall be included in all
+ #copies or substantial portions of the Software.
+ #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+ #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #SOFTWARE.
+ #=
+
+module Copyleaks
+  class Metadata
+    attr_reader :finalUrl, :canonicalUrl, :publishDate, :creationDate,
+                :lastModificationDate, :author, :organization, :filename
+
+    # @param [String] finalUrl - The final URL of the document.
+    # @param [String] canonicalUrl - The canonical URL if available.
+    # @param [String] publishDate - The date the content was published.
+    # @param [String] creationDate - The date the content was created.
+    # @param [String] lastModificationDate - The last time the content was modified.
+    # @param [String] author - The author of the content.
+    # @param [String] organization - The organization associated with the content.
+    # @param [String] filename - The original filename of the content.
+    def initialize(finalUrl: nil, canonicalUrl: nil, publishDate: nil, creationDate: nil,
+                   lastModificationDate: nil, author: nil, organization: nil, filename: nil)
+
+      if !finalUrl.nil? && !finalUrl.is_a?(String)
+        raise 'Copyleaks::Metadata - finalUrl must be a String'
+      end
+      if !canonicalUrl.nil? && !canonicalUrl.is_a?(String)
+        raise 'Copyleaks::Metadata - canonicalUrl must be a String'
+      end
+      if !publishDate.nil? && !publishDate.is_a?(String)
+        raise 'Copyleaks::Metadata - publishDate must be a String'
+      end
+      if !creationDate.nil? && !creationDate.is_a?(String)
+        raise 'Copyleaks::Metadata - creationDate must be a String'
+      end
+      if !lastModificationDate.nil? && !lastModificationDate.is_a?(String)
+        raise 'Copyleaks::Metadata - lastModificationDate must be a String'
+      end
+      if !author.nil? && !author.is_a?(String)
+        raise 'Copyleaks::Metadata - author must be a String'
+      end
+      if !organization.nil? && !organization.is_a?(String)
+        raise 'Copyleaks::Metadata - organization must be a String'
+      end
+      if !filename.nil? && !filename.is_a?(String)
+        raise 'Copyleaks::Metadata - filename must be a String'
+      end
+
+      @finalUrl = finalUrl
+      @canonicalUrl = canonicalUrl
+      @publishDate = publishDate
+      @creationDate = creationDate
+      @lastModificationDate = lastModificationDate
+      @author = author
+      @organization = organization
+      @filename = filename
+    end
+
+    def as_json(*_args)
+      {
+        finalUrl: @finalUrl,
+        canonicalUrl: @canonicalUrl,
+        publishDate: @publishDate,
+        creationDate: @creationDate,
+        lastModificationDate: @lastModificationDate,
+        author: @author,
+        organization: @organization,
+        filename: @filename
+      }.select { |_k, v| !v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/StatusWebhook.rb

@@ -0,0 +1,42 @@
+ #The MIT License(MIT)
+ #Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+ #Permission is hereby granted, free of charge, to any person obtaining a copy
+ #of this software and associated documentation files (the "Software"), to deal
+ #in the Software without restriction, including without limitation the rights
+ #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #copies of the Software, and to permit persons to whom the Software is
+ #furnished to do so, subject to the following conditions:
+ #The above copyright notice and this permission notice shall be included in all
+ #copies or substantial portions of the Software.
+ #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+ #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #SOFTWARE.
+ #=
+module Copyleaks
+  class StatusWebhook < Webhook
+    # @param [Integer] status - The current status of the scan.
+    attr_reader :status
+
+    def initialize(status:, **args)
+      unless status.is_a?(Integer)
+        raise 'Copyleaks::StatusWebhook - status must be an Integer'
+      end
+      super(**args)
+      @status = status
+    end
+
+    def as_json(*_args)
+      {
+        status: @status
+      }.merge(super)
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Webhook.rb

@@ -0,0 +1,43 @@
+ #The MIT License(MIT)
+ #Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+ #Permission is hereby granted, free of charge, to any person obtaining a copy
+ #of this software and associated documentation files (the "Software"), to deal
+ #in the Software without restriction, including without limitation the rights
+ #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #copies of the Software, and to permit persons to whom the Software is
+ #furnished to do so, subject to the following conditions:
+ #The above copyright notice and this permission notice shall be included in all
+ #copies or substantial portions of the Software.
+ #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+ #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #SOFTWARE.
+ #=
+module Copyleaks
+  class Webhook
+
+    # @param [String] developerPayload - The developer payload that was provided in the submit method.
+    attr_reader :developerPayload
+
+    def initialize(developerPayload: nil,**args)
+      if !developerPayload.nil? && !developerPayload.is_a?(String)
+        raise 'Copyleaks::Webhook - developerPayload must be a String'
+      end
+      @developerPayload = developerPayload
+      @extra_fields = args
+    end
+
+    def as_json(*_args)
+      {
+        developerPayload: @developerPayload
+      }.compact
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/HelperModels/CompletedModels/Notifications.rb

@@ -0,0 +1,43 @@
+ #The MIT License(MIT)
+ #Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+ #Permission is hereby granted, free of charge, to any person obtaining a copy
+ #of this software and associated documentation files (the "Software"), to deal
+ #in the Software without restriction, including without limitation the rights
+ #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #copies of the Software, and to permit persons to whom the Software is
+ #furnished to do so, subject to the following conditions:
+ #The above copyright notice and this permission notice shall be included in all
+ #copies or substantial portions of the Software.
+ #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+ #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #SOFTWARE.
+ #=
+
+module Copyleaks
+  class Notifications
+    attr_reader :alerts
+
+    # @param [Array<Alerts>] alerts - A list of scan alerts that were detected in the scan.
+    def initialize(alerts: nil)
+      if !alerts.nil? && !(alerts.is_a?(Array) && alerts.all? { |a| a.is_a?(Alerts) })
+        raise 'Copyleaks::Notifications - alerts must be an array of Alerts objects'
+      end
+
+      @alerts = alerts
+    end
+
+    def as_json(*_args)
+      {
+        alerts: @alerts
+      }.select { |_k, v| !v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/HelperModels/CompletedModels/Results.rb

@@ -0,0 +1,68 @@
+ #The MIT License(MIT)
+ #Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+ #Permission is hereby granted, free of charge, to any person obtaining a copy
+ #of this software and associated documentation files (the "Software"), to deal
+ #in the Software without restriction, including without limitation the rights
+ #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #copies of the Software, and to permit persons to whom the Software is
+ #furnished to do so, subject to the following conditions:
+ #The above copyright notice and this permission notice shall be included in all
+ #copies or substantial portions of the Software.
+ #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+ #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #SOFTWARE.
+ #=
+
+
+module Copyleaks
+  class Results
+    attr_reader :database, :batch, :repositories, :score, :internet
+
+    # @param [Array<Database>] database
+    # @param [Array<Batch>] batch
+    # @param [Array<Repositories>] repositories
+    # @param [Score] score
+    # @param [Array<Internet>] internet
+    def initialize(database: nil, batch: nil, repositories: nil, score: nil, internet: nil)
+      if !database.nil? && !(database.is_a?(Array) && database.all? { |d| d.is_a?(Database) })
+        raise 'Copyleaks::Results - database must be an array of Database objects'
+      end
+      if !batch.nil? && !(batch.is_a?(Array) && batch.all? { |b| b.is_a?(Batch) })
+        raise 'Copyleaks::Results - batch must be an array of Batch objects'
+      end
+      if !repositories.nil? && !(repositories.is_a?(Array) && repositories.all? { |r| r.is_a?(Repositories) })
+        raise 'Copyleaks::Results - repositories must be an array of Repositories objects'
+      end
+      if !score.nil? && !score.is_a?(Score)
+        raise 'Copyleaks::Results - score must be a Score object'
+      end
+      if !internet.nil? && !(internet.is_a?(Array) && internet.all? { |i| i.is_a?(Internet) })
+        raise 'Copyleaks::Results - internet must be an array of Internet objects'
+      end
+
+      @database = database
+      @batch = batch
+      @repositories = repositories
+      @score = score
+      @internet = internet
+    end
+
+    def as_json(*_args)
+      {
+        database: @database,
+        batch: @batch,
+        repositories: @repositories,
+        score: @score,
+        internet: @internet
+      }.select { |_k, v| !v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/HelperModels/CompletedModels/ScannedDocument.rb

@@ -0,0 +1,61 @@
+ #The MIT License(MIT)
+ #Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+ #Permission is hereby granted, free of charge, to any person obtaining a copy
+ #of this software and associated documentation files (the "Software"), to deal
+ #in the Software without restriction, including without limitation the rights
+ #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #copies of the Software, and to permit persons to whom the Software is
+ #furnished to do so, subject to the following conditions:
+ #The above copyright notice and this permission notice shall be included in all
+ #copies or substantial portions of the Software.
+ #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+ #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #SOFTWARE.
+ #=
+
+module Copyleaks
+  class ScannedDocument
+    attr_reader :scanId, :totalWords, :totalExcluded, :credits, :creationTime, :metadata
+
+    # @param [String] scanId - The unique scan id provided by you.
+    # @param [Integer] totalWords - Total number of words found in the scanned text.
+    # @param [Integer] totalExcluded - Number of excluded words in the submitted content.
+    # @param [Integer] credits - Overall credits used for the scan.
+    # @param [String] creationTime - The creation time of the scan.
+    # @param [Metadata] metadata - Metadata object
+    def initialize(scanId:, totalWords:, totalExcluded:, credits:, creationTime:, metadata:)
+      raise 'scanId must be a String' unless scanId.is_a?(String)
+      raise 'totalWords must be an Integer' unless totalWords.is_a?(Integer)
+      raise 'totalExcluded must be an Integer' unless totalExcluded.is_a?(Integer)
+      raise 'credits must be an Integer' unless credits.is_a?(Integer)
+      raise 'creationTime must be a String' unless creationTime.is_a?(String)
+      raise 'metadata must be a Metadata object' unless metadata.is_a?(Metadata)
+
+      @scanId = scanId
+      @totalWords = totalWords
+      @totalExcluded = totalExcluded
+      @credits = credits
+      @creationTime = creationTime
+      @metadata = metadata
+    end
+
+    def as_json(*_args)
+      {
+        scanId: @scanId,
+        totalWords: @totalWords,
+        totalExcluded: @totalExcluded,
+        credits: @credits,
+        creationTime: @creationTime,
+        metadata: @metadata
+      }.select { |_k, v| !v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/HelperModels/ErrorModels/Error.rb

@@ -0,0 +1,46 @@
+ #The MIT License(MIT)
+ #Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+ #Permission is hereby granted, free of charge, to any person obtaining a copy
+ #of this software and associated documentation files (the "Software"), to deal
+ #in the Software without restriction, including without limitation the rights
+ #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #copies of the Software, and to permit persons to whom the Software is
+ #furnished to do so, subject to the following conditions:
+ #The above copyright notice and this permission notice shall be included in all
+ #copies or substantial portions of the Software.
+ #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+ #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #SOFTWARE.
+ #=
+
+
+module Copyleaks
+  class Error
+    attr_reader :code, :message
+
+    # @param [Integer] code - Error code that represents the reason for failure. 
+    # @param [String] message - Error message that represents the reason for failure.
+    def initialize(code:, message:)
+      raise 'Copyleaks::Error - code must be an Integer' unless code.is_a?(Integer)
+      raise 'Copyleaks::Error - message must be a String' unless message.is_a?(String)
+
+      @code = code
+      @message = message
+    end
+
+    def as_json(*_args)
+      {
+        code: @code,
+        message: @message
+      }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end