apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/rating.rb

@@ -0,0 +1,38 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # | value | description | |-------|---------------| | RATING_GOOD | Autotriage
+  # rated positively by a user. | | RATING_BAD | Autotriage rated negatively by
+  # a user. |
+  class Rating
+    RATING = [
+      # TODO: Write general description for RATING_GOOD
+      RATING_GOOD = 'RATING_GOOD'.freeze,
+
+      # TODO: Write general description for RATING_BAD
+      RATING_BAD = 'RATING_BAD'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RATING.include?(value)
+    end
+
+    def self.from_value(value, default_value = RATING_GOOD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'rating_good' then RATING_GOOD
+      when 'rating_bad' then RATING_BAD
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/reachability.rb

@@ -0,0 +1,48 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Indicates whether the vulnerable code is reachable
+  class Reachability
+    REACHABILITY = [
+      # TODO: Write general description for ENUM_NO_REACHABILITY_ANALYSIS
+      ENUM_NO_REACHABILITY_ANALYSIS = 'no reachability analysis'.freeze,
+
+      # TODO: Write general description for REACHABLE
+      REACHABLE = 'reachable'.freeze,
+
+      # TODO: Write general description for ENUM_ALWAYS_REACHABLE
+      ENUM_ALWAYS_REACHABLE = 'always reachable'.freeze,
+
+      # TODO: Write general description for ENUM_CONDITIONALLY_REACHABLE
+      ENUM_CONDITIONALLY_REACHABLE = 'conditionally reachable'.freeze,
+
+      # TODO: Write general description for UNREACHABLE
+      UNREACHABLE = 'unreachable'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REACHABILITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_NO_REACHABILITY_ANALYSIS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_no_reachability_analysis' then ENUM_NO_REACHABILITY_ANALYSIS
+      when 'reachable' then REACHABLE
+      when 'enum_always_reachable' then ENUM_ALWAYS_REACHABLE
+      when 'enum_conditionally_reachable' then ENUM_CONDITIONALLY_REACHABLE
+      when 'unreachable' then UNREACHABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/repository_visibility.rb

@@ -0,0 +1,40 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Filter by repository visibility. Only applies for secrets findings.
+  class RepositoryVisibility
+    REPOSITORY_VISIBILITY = [
+      # TODO: Write general description for PUBLIC
+      PUBLIC = 'public'.freeze,
+
+      # TODO: Write general description for PRIVATE
+      PRIVATE = 'private'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REPOSITORY_VISIBILITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = PUBLIC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'public' then PUBLIC
+      when 'private' then PRIVATE
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/review_comment.rb

@@ -0,0 +1,100 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # External review comment information associated with a finding
+  class ReviewComment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # External ID of the review comment or discussion thread
+    # @return [String]
+    attr_accessor :external_discussion_id
+
+    # External ID of the specific note in the review comment discussion thread.
+    # Only applicable for GitLab.com, GitLab Self-Managed and Azure DevOps
+    # @return [String]
+    attr_accessor :external_note_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_discussion_id'] = 'external_discussion_id'
+      @_hash['external_note_id'] = 'external_note_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_discussion_id
+        external_note_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_discussion_id: SKIP, external_note_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @external_discussion_id = external_discussion_id unless external_discussion_id == SKIP
+      @external_note_id = external_note_id unless external_note_id == 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.
+      external_discussion_id =
+        hash.key?('external_discussion_id') ? hash['external_discussion_id'] : SKIP
+      external_note_id =
+        hash.key?('external_note_id') ? hash['external_note_id'] : 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.
+      ReviewComment.new(external_discussion_id: external_discussion_id,
+                        external_note_id: external_note_id,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ReviewComment | 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} external_discussion_id: #{@external_discussion_id}, external_note_id:"\
+      " #{@external_note_id}, 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} external_discussion_id: #{@external_discussion_id.inspect},"\
+      " external_note_id: #{@external_note_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/risk.rb

@@ -0,0 +1,40 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Component risk level
+  class Risk
+    RISK = [
+      # TODO: Write general description for HIGH
+      HIGH = 'high'.freeze,
+
+      # TODO: Write general description for LOW
+      LOW = 'low'.freeze,
+
+      # TODO: Write general description for NEUTRAL
+      NEUTRAL = 'neutral'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RISK.include?(value)
+    end
+
+    def self.from_value(value, default_value = HIGH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'high' then HIGH
+      when 'low' then LOW
+      when 'neutral' then NEUTRAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/rule.rb

@@ -0,0 +1,292 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module SemgrepWebApp
+  # Rule Model.
+  class Rule < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Category the Rule is associated with.
+    # @return [String]
+    attr_accessor :category
+
+    # Confidence based on the Rule's false-positive rate.
+    # | value | description |
+    # |-------|---------------|
+    # | CONFIDENCE_HIGH |  |
+    # | CONFIDENCE_MEDIUM |  |
+    # | CONFIDENCE_LOW |  |
+    # @return [Confidence]
+    attr_accessor :confidence
+
+    # The CWE associated with the Rule.
+    # @return [Array[String]]
+    attr_accessor :cwe_categories
+
+    # When True, the secrets rule has validators.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_validators
+
+    # ID of the Rule.
+    # @return [String]
+    attr_accessor :id
+
+    # Languages the Rule applies to.
+    # @return [Array[String]]
+    attr_accessor :languages
+
+    # Timestamp of when the Rule was last changed.
+    # @return [DateTime]
+    attr_accessor :last_change_at
+
+    # Username of who last changed the Rule.
+    # @return [String]
+    attr_accessor :last_change_by
+
+    # Owasp categories the Rule is associated with.
+    # @return [Array[String]]
+    attr_accessor :owasp_categories
+
+    # Full path of the Rule.
+    # @return [String]
+    attr_accessor :path
+
+    # Mode behavior: Monitor / Comment / Block / Disabled
+    # | value | description |
+    # |-------|---------------|
+    # | MODE_MONITOR | Monitor mode, silently report findings |
+    # | MODE_COMMENT | Comment mode, leaves PR comments but does not block |
+    # | MODE_BLOCK | Block mode, leaves PR comments and blocks PR |
+    # | MODE_DISABLED | Disabled mode, not active |
+    # @return [PolicyMode]
+    attr_accessor :policy_mode
+
+    # The Registry maintainer associated with the Rule (if applicable).
+    # @return [String]
+    attr_accessor :registry_maintainer
+
+    # Rulesets to which the Rule belongs (if applicable).
+    # @return [Array[String]]
+    attr_accessor :rulesets
+
+    # The secret type (if applicable).
+    # @return [String]
+    attr_accessor :secret_type
+
+    # Severity level ("seriousness" of the finding)
+    # | value | description |
+    # |-------|---------------|
+    # | SEVERITY_HIGH |  |
+    # | SEVERITY_MEDIUM |  |
+    # | SEVERITY_LOW |  |
+    # | SEVERITY_CRITICAL |  |
+    # @return [Severity]
+    attr_accessor :severity
+
+    # Source of the Rule
+    # | value | description |
+    # |-------|---------------|
+    # | SOURCE_PRO | From Pro rules |
+    # | SOURCE_COMMUNITY | From Semgrep Community rules |
+    # | SOURCE_CUSTOM | From Custom rules |
+    # @return [Source]
+    attr_accessor :source
+
+    # Technologies the Rule is associated with.
+    # @return [Array[String]]
+    attr_accessor :technologies
+
+    # The URL of the Rule.
+    # @return [String]
+    attr_accessor :url
+
+    # Vulnerability classes the Rule is associated with.
+    # @return [Array[String]]
+    attr_accessor :vulnerability_class
+
+    # 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_categories'] = 'cweCategories'
+      @_hash['has_validators'] = 'hasValidators'
+      @_hash['id'] = 'id'
+      @_hash['languages'] = 'languages'
+      @_hash['last_change_at'] = 'lastChangeAt'
+      @_hash['last_change_by'] = 'lastChangeBy'
+      @_hash['owasp_categories'] = 'owaspCategories'
+      @_hash['path'] = 'path'
+      @_hash['policy_mode'] = 'policyMode'
+      @_hash['registry_maintainer'] = 'registryMaintainer'
+      @_hash['rulesets'] = 'rulesets'
+      @_hash['secret_type'] = 'secretType'
+      @_hash['severity'] = 'severity'
+      @_hash['source'] = 'source'
+      @_hash['technologies'] = 'technologies'
+      @_hash['url'] = 'url'
+      @_hash['vulnerability_class'] = 'vulnerabilityClass'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category
+        confidence
+        cwe_categories
+        has_validators
+        id
+        languages
+        last_change_at
+        last_change_by
+        owasp_categories
+        path
+        policy_mode
+        registry_maintainer
+        rulesets
+        secret_type
+        severity
+        source
+        technologies
+        url
+        vulnerability_class
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(category: SKIP, confidence: SKIP, cwe_categories: SKIP,
+                   has_validators: SKIP, id: SKIP, languages: SKIP,
+                   last_change_at: SKIP, last_change_by: SKIP,
+                   owasp_categories: SKIP, path: SKIP, policy_mode: SKIP,
+                   registry_maintainer: SKIP, rulesets: SKIP, secret_type: SKIP,
+                   severity: SKIP, source: SKIP, technologies: SKIP, url: SKIP,
+                   vulnerability_class: 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_categories = cwe_categories unless cwe_categories == SKIP
+      @has_validators = has_validators unless has_validators == SKIP
+      @id = id unless id == SKIP
+      @languages = languages unless languages == SKIP
+      @last_change_at = last_change_at unless last_change_at == SKIP
+      @last_change_by = last_change_by unless last_change_by == SKIP
+      @owasp_categories = owasp_categories unless owasp_categories == SKIP
+      @path = path unless path == SKIP
+      @policy_mode = policy_mode unless policy_mode == SKIP
+      @registry_maintainer = registry_maintainer unless registry_maintainer == SKIP
+      @rulesets = rulesets unless rulesets == SKIP
+      @secret_type = secret_type unless secret_type == SKIP
+      @severity = severity unless severity == SKIP
+      @source = source unless source == SKIP
+      @technologies = technologies unless technologies == SKIP
+      @url = url unless url == SKIP
+      @vulnerability_class = vulnerability_class unless vulnerability_class == 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_categories = hash.key?('cweCategories') ? hash['cweCategories'] : SKIP
+      has_validators = hash.key?('hasValidators') ? hash['hasValidators'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      languages = hash.key?('languages') ? hash['languages'] : SKIP
+      last_change_at = if hash.key?('lastChangeAt')
+                         (DateTimeHelper.from_rfc3339(hash['lastChangeAt']) if hash['lastChangeAt'])
+                       else
+                         SKIP
+                       end
+      last_change_by = hash.key?('lastChangeBy') ? hash['lastChangeBy'] : SKIP
+      owasp_categories =
+        hash.key?('owaspCategories') ? hash['owaspCategories'] : SKIP
+      path = hash.key?('path') ? hash['path'] : SKIP
+      policy_mode = hash.key?('policyMode') ? hash['policyMode'] : SKIP
+      registry_maintainer =
+        hash.key?('registryMaintainer') ? hash['registryMaintainer'] : SKIP
+      rulesets = hash.key?('rulesets') ? hash['rulesets'] : SKIP
+      secret_type = hash.key?('secretType') ? hash['secretType'] : SKIP
+      severity = hash.key?('severity') ? hash['severity'] : SKIP
+      source = hash.key?('source') ? hash['source'] : SKIP
+      technologies = hash.key?('technologies') ? hash['technologies'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      vulnerability_class =
+        hash.key?('vulnerabilityClass') ? hash['vulnerabilityClass'] : 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.
+      Rule.new(category: category,
+               confidence: confidence,
+               cwe_categories: cwe_categories,
+               has_validators: has_validators,
+               id: id,
+               languages: languages,
+               last_change_at: last_change_at,
+               last_change_by: last_change_by,
+               owasp_categories: owasp_categories,
+               path: path,
+               policy_mode: policy_mode,
+               registry_maintainer: registry_maintainer,
+               rulesets: rulesets,
+               secret_type: secret_type,
+               severity: severity,
+               source: source,
+               technologies: technologies,
+               url: url,
+               vulnerability_class: vulnerability_class,
+               additional_properties: additional_properties)
+    end
+
+    def to_custom_last_change_at
+      DateTimeHelper.to_rfc3339(last_change_at)
+    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_categories:"\
+      " #{@cwe_categories}, has_validators: #{@has_validators}, id: #{@id}, languages:"\
+      " #{@languages}, last_change_at: #{@last_change_at}, last_change_by: #{@last_change_by},"\
+      " owasp_categories: #{@owasp_categories}, path: #{@path}, policy_mode: #{@policy_mode},"\
+      " registry_maintainer: #{@registry_maintainer}, rulesets: #{@rulesets}, secret_type:"\
+      " #{@secret_type}, severity: #{@severity}, source: #{@source}, technologies:"\
+      " #{@technologies}, url: #{@url}, vulnerability_class: #{@vulnerability_class},"\
+      " 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_categories: #{@cwe_categories.inspect}, has_validators: #{@has_validators.inspect},"\
+      " id: #{@id.inspect}, languages: #{@languages.inspect}, last_change_at:"\
+      " #{@last_change_at.inspect}, last_change_by: #{@last_change_by.inspect}, owasp_categories:"\
+      " #{@owasp_categories.inspect}, path: #{@path.inspect}, policy_mode:"\
+      " #{@policy_mode.inspect}, registry_maintainer: #{@registry_maintainer.inspect}, rulesets:"\
+      " #{@rulesets.inspect}, secret_type: #{@secret_type.inspect}, severity:"\
+      " #{@severity.inspect}, source: #{@source.inspect}, technologies: #{@technologies.inspect},"\
+      " url: #{@url.inspect}, vulnerability_class: #{@vulnerability_class.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/rule_explanation.rb

@@ -0,0 +1,98 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # AI-generated explanation of why a rule flagged this specific code
+  class RuleExplanation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Detailed explanation of why this rule flagged the code, including context
+    # about the security issue and why it applies to this specific code. AI
+    # generated content, review carefully
+    # @return [String]
+    attr_accessor :explanation
+
+    # A concise summary of the rule explanation. May not be present for all
+    # findings
+    # @return [String]
+    attr_accessor :summary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['explanation'] = 'explanation'
+      @_hash['summary'] = 'summary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        explanation
+        summary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(explanation: SKIP, summary: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @explanation = explanation unless explanation == SKIP
+      @summary = summary unless summary == 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.
+      explanation = hash.key?('explanation') ? hash['explanation'] : SKIP
+      summary = hash.key?('summary') ? hash['summary'] : 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.
+      RuleExplanation.new(explanation: explanation,
+                          summary: summary,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RuleExplanation | 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} explanation: #{@explanation}, summary: #{@summary}, 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} explanation: #{@explanation.inspect}, summary: #{@summary.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end