apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/finding_location.rb

@@ -0,0 +1,126 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Location of the record in a file, as reported by Semgrep. If null, then the
+  # information does not exist or lacks integrity (older or broken scans)
+  class FindingLocation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Column at which the target starts
+    # @return [Integer]
+    attr_accessor :column
+
+    # Column at which the target ends
+    # @return [Integer]
+    attr_accessor :end_column
+
+    # Line at which the target ends
+    # @return [Integer]
+    attr_accessor :end_line
+
+    # File path of the relevant line and column numbers
+    # @return [String]
+    attr_accessor :file_path
+
+    # Line at which the target starts
+    # @return [Integer]
+    attr_accessor :line
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['column'] = 'column'
+      @_hash['end_column'] = 'end_column'
+      @_hash['end_line'] = 'end_line'
+      @_hash['file_path'] = 'file_path'
+      @_hash['line'] = 'line'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        column
+        end_column
+        end_line
+        file_path
+        line
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(column: SKIP, end_column: SKIP, end_line: SKIP,
+                   file_path: SKIP, line: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @column = column unless column == SKIP
+      @end_column = end_column unless end_column == SKIP
+      @end_line = end_line unless end_line == SKIP
+      @file_path = file_path unless file_path == SKIP
+      @line = line unless line == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      column = hash.key?('column') ? hash['column'] : SKIP
+      end_column = hash.key?('end_column') ? hash['end_column'] : SKIP
+      end_line = hash.key?('end_line') ? hash['end_line'] : SKIP
+      file_path = hash.key?('file_path') ? hash['file_path'] : SKIP
+      line = hash.key?('line') ? hash['line'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FindingLocation.new(column: column,
+                          end_column: end_column,
+                          end_line: end_line,
+                          file_path: file_path,
+                          line: line,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FindingLocation | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} column: #{@column}, end_column: #{@end_column}, end_line: #{@end_line},"\
+      " file_path: #{@file_path}, line: #{@line}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} column: #{@column.inspect}, end_column: #{@end_column.inspect}, end_line:"\
+      " #{@end_line.inspect}, file_path: #{@file_path.inspect}, line: #{@line.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/finding_repository.rb

@@ -0,0 +1,95 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Which repository this finding was identified in
+  class FindingRepository < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The repository or named project that the finding is associated with
+    # @return [String]
+    attr_accessor :name
+
+    # The source URL from which this repository last scanned
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @url = url unless url == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FindingRepository.new(name: name,
+                            url: url,
+                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FindingRepository | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, url: #{@url}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, url: #{@url.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/finding_rule.rb

@@ -0,0 +1,158 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Rule that applies to this finding
+  class FindingRule < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Category the rule is associated with
+    # @return [String]
+    attr_accessor :category
+
+    # Confidence level of the rule
+    # @return [Confidence2]
+    attr_accessor :confidence
+
+    # CWE names associated with the rule
+    # @return [Array[String]]
+    attr_accessor :cwe_names
+
+    # Rule message
+    # @return [String]
+    attr_accessor :message
+
+    # Name of the rule
+    # @return [String]
+    attr_accessor :name
+
+    # OWASP names associated with the rule
+    # @return [Array[String]]
+    attr_accessor :owasp_names
+
+    # Subcategories of the rule
+    # @return [Array[String]]
+    attr_accessor :subcategories
+
+    # Vulnerability classes the rule is associated with
+    # @return [Array[String]]
+    attr_accessor :vulnerability_classes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['category'] = 'category'
+      @_hash['confidence'] = 'confidence'
+      @_hash['cwe_names'] = 'cwe_names'
+      @_hash['message'] = 'message'
+      @_hash['name'] = 'name'
+      @_hash['owasp_names'] = 'owasp_names'
+      @_hash['subcategories'] = 'subcategories'
+      @_hash['vulnerability_classes'] = 'vulnerability_classes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category
+        confidence
+        cwe_names
+        message
+        name
+        owasp_names
+        subcategories
+        vulnerability_classes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(category: SKIP, confidence: SKIP, cwe_names: SKIP,
+                   message: SKIP, name: SKIP, owasp_names: SKIP,
+                   subcategories: SKIP, vulnerability_classes: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @category = category unless category == SKIP
+      @confidence = confidence unless confidence == SKIP
+      @cwe_names = cwe_names unless cwe_names == SKIP
+      @message = message unless message == SKIP
+      @name = name unless name == SKIP
+      @owasp_names = owasp_names unless owasp_names == SKIP
+      @subcategories = subcategories unless subcategories == SKIP
+      @vulnerability_classes = vulnerability_classes unless vulnerability_classes == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      category = hash.key?('category') ? hash['category'] : SKIP
+      confidence = hash.key?('confidence') ? hash['confidence'] : SKIP
+      cwe_names = hash.key?('cwe_names') ? hash['cwe_names'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      owasp_names = hash.key?('owasp_names') ? hash['owasp_names'] : SKIP
+      subcategories = hash.key?('subcategories') ? hash['subcategories'] : SKIP
+      vulnerability_classes =
+        hash.key?('vulnerability_classes') ? hash['vulnerability_classes'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FindingRule.new(category: category,
+                      confidence: confidence,
+                      cwe_names: cwe_names,
+                      message: message,
+                      name: name,
+                      owasp_names: owasp_names,
+                      subcategories: subcategories,
+                      vulnerability_classes: vulnerability_classes,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FindingRule | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} category: #{@category}, confidence: #{@confidence}, cwe_names:"\
+      " #{@cwe_names}, message: #{@message}, name: #{@name}, owasp_names: #{@owasp_names},"\
+      " subcategories: #{@subcategories}, vulnerability_classes: #{@vulnerability_classes},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} category: #{@category.inspect}, confidence: #{@confidence.inspect},"\
+      " cwe_names: #{@cwe_names.inspect}, message: #{@message.inspect}, name: #{@name.inspect},"\
+      " owasp_names: #{@owasp_names.inspect}, subcategories: #{@subcategories.inspect},"\
+      " vulnerability_classes: #{@vulnerability_classes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/fix_recommendation.rb

@@ -0,0 +1,95 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Recommendation for fixing the vulnerability
+  class FixRecommendation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The package for which a fix is recommended
+    # @return [String]
+    attr_accessor :package
+
+    # The recommended version of the package
+    # @return [String]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['package'] = 'package'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        package
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(package: SKIP, version: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @package = package unless package == SKIP
+      @version = version unless version == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      package = hash.key?('package') ? hash['package'] : SKIP
+      version = hash.key?('version') ? hash['version'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FixRecommendation.new(package: package,
+                            version: version,
+                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FixRecommendation | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} package: #{@package}, version: #{@version}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} package: #{@package.inspect}, version: #{@version.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/float_range.rb

@@ -0,0 +1,85 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # FloatRange Model.
+  class FloatRange < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # End of the range
+    # @return [Float]
+    attr_accessor :max
+
+    # Start of the range
+    # @return [Float]
+    attr_accessor :min
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['max'] = 'max'
+      @_hash['min'] = 'min'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        max
+        min
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(max: SKIP, min: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @max = max unless max == SKIP
+      @min = min unless min == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      max = hash.key?('max') ? hash['max'] : SKIP
+      min = hash.key?('min') ? hash['min'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FloatRange.new(max: max,
+                     min: min,
+                     additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} max: #{@max}, min: #{@min}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} max: #{@max.inspect}, min: #{@min.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/format.rb

@@ -0,0 +1,27 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Format for the SBOM export. | value | description |
+  # |-------|---------------| | SBOM_FORMAT_CYCLONEDX |  |
+  class Format
+    FORMAT = [
+      # TODO: Write general description for SBOM_FORMAT_CYCLONEDX
+      SBOM_FORMAT_CYCLONEDX = 'SBOM_FORMAT_CYCLONEDX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FORMAT.include?(value)
+    end
+
+    def self.from_value(value, default_value = SBOM_FORMAT_CYCLONEDX)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end