apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/sast_finding.rb

@@ -0,0 +1,426 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # A Code finding that Semgrep has identified in your organization
+  class SastFinding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Semgrep Assistant data. Only present if Assistant is enabled
+    # @return [Assistant]
+    attr_accessor :assistant
+
+    # The categories of the finding as classified by the associated rule
+    # metadata
+    # @return [Array[String]]
+    attr_accessor :categories
+
+    # Failed PR creation attempts by Semgrep's autofix feature (Click to Fix)
+    # for this finding
+    # @return [Array[ClickToFixFailure]]
+    attr_accessor :click_to_fix_failures
+
+    # Pull requests created by Semgrep's autofix feature (Click to Fix) for this
+    # finding
+    # @return [Array[ClickToFixPr]]
+    attr_accessor :click_to_fix_prs
+
+    # Confidence of the finding, derived from the rule that triggered it
+    # @return [Confidence1]
+    attr_accessor :confidence
+
+    # The timestamp when this finding was created
+    # @return [String]
+    attr_accessor :created_at
+
+    # External ticket associated with finding
+    # @return [ExternalTicket]
+    attr_accessor :external_ticket
+
+    # Unique ID of the Semgrep scan that first identified this finding
+    # @return [Integer]
+    attr_accessor :first_seen_scan_id
+
+    # Unique ID of this finding
+    # @return [Integer]
+    attr_accessor :id
+
+    # The source URL including file and line number
+    # @return [String]
+    attr_accessor :line_of_code_url
+
+    # 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)
+    # @return [FindingLocation]
+    attr_accessor :location
+
+    # ID calculated based on a finding's file path, rule identifier and pattern,
+    # and index
+    # @return [String]
+    attr_accessor :match_based_id
+
+    # External reference to the source of this finding (e.g. PR)
+    # @return [String]
+    attr_accessor :ref
+
+    # The timestamp when this finding was detected by Semgrep (the first time,
+    # or when reintroduced)
+    # @return [String]
+    attr_accessor :relevant_since
+
+    # Which repository this finding was identified in
+    # @return [FindingRepository]
+    attr_accessor :repository
+
+    # List of external review comment information associated with a finding
+    # @return [Array[ReviewComment]]
+    attr_accessor :review_comments
+
+    # Rule that applies to this finding
+    # @return [FindingRule]
+    attr_accessor :rule
+
+    # Deprecated in favor of rule.message. Rule message at the time of finding
+    # identification. Older findings may not have a value for this field
+    # @return [String]
+    attr_accessor :rule_message
+
+    # Deprecated in favor of rule.name
+    # @return [String]
+    attr_accessor :rule_name
+
+    # Severity of the finding, derived from the rule that triggered it. Low is
+    # equivalent to INFO, Medium to WARNING, and High to ERROR
+    # @return [Severity1]
+    attr_accessor :severity
+
+    # Reference to a policy, with some basic information. If null, then the
+    # information does not exist or lacks integrity (older or broken scans)
+    # @return [PolicyReference]
+    attr_accessor :sourcing_policy
+
+    # The finding's resolution state. Managed only by changes detected at scan
+    # time, the `state` is combined with `triage_state` to ultimately determine
+    # a final `status` which is exposed in the UI and API
+    # @return [State]
+    attr_accessor :state
+
+    # When this issue's `state` (resolution state) was last updated, as distinct
+    # from when the issue was triaged (`triaged_at`)
+    # @return [String]
+    attr_accessor :state_updated_at
+
+    # The finding's status as exposed in the UI. Status is a derived property
+    # combining information from the finding `state` and `triage_state`. The
+    # `triage_state` can be used to override the scan state if the finding is
+    # still detected
+    # @return [Status]
+    attr_accessor :status
+
+    # ID calculated based on a finding's file path, rule identifier and matched
+    # code, and index. Prefer `match_based_id`
+    # @return [String]
+    attr_accessor :syntactic_id
+
+    # The detailed comment provided during triage
+    # @return [String]
+    attr_accessor :triage_comment
+
+    # Reason provided when this issue was triaged
+    # @return [TriageReason]
+    attr_accessor :triage_reason
+
+    # The finding's triage state. Note: "reviewing" and "fixing" are only in
+    # private beta. Set by the user and used along with state to generate the
+    # final "status" viewable in the UI
+    # @return [TriageState]
+    attr_accessor :triage_state
+
+    # When the finding was triaged
+    # @return [String]
+    attr_accessor :triaged_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['assistant'] = 'assistant'
+      @_hash['categories'] = 'categories'
+      @_hash['click_to_fix_failures'] = 'click_to_fix_failures'
+      @_hash['click_to_fix_prs'] = 'click_to_fix_prs'
+      @_hash['confidence'] = 'confidence'
+      @_hash['created_at'] = 'created_at'
+      @_hash['external_ticket'] = 'external_ticket'
+      @_hash['first_seen_scan_id'] = 'first_seen_scan_id'
+      @_hash['id'] = 'id'
+      @_hash['line_of_code_url'] = 'line_of_code_url'
+      @_hash['location'] = 'location'
+      @_hash['match_based_id'] = 'match_based_id'
+      @_hash['ref'] = 'ref'
+      @_hash['relevant_since'] = 'relevant_since'
+      @_hash['repository'] = 'repository'
+      @_hash['review_comments'] = 'review_comments'
+      @_hash['rule'] = 'rule'
+      @_hash['rule_message'] = 'rule_message'
+      @_hash['rule_name'] = 'rule_name'
+      @_hash['severity'] = 'severity'
+      @_hash['sourcing_policy'] = 'sourcing_policy'
+      @_hash['state'] = 'state'
+      @_hash['state_updated_at'] = 'state_updated_at'
+      @_hash['status'] = 'status'
+      @_hash['syntactic_id'] = 'syntactic_id'
+      @_hash['triage_comment'] = 'triage_comment'
+      @_hash['triage_reason'] = 'triage_reason'
+      @_hash['triage_state'] = 'triage_state'
+      @_hash['triaged_at'] = 'triaged_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        assistant
+        categories
+        click_to_fix_failures
+        click_to_fix_prs
+        confidence
+        created_at
+        external_ticket
+        first_seen_scan_id
+        id
+        line_of_code_url
+        location
+        match_based_id
+        ref
+        relevant_since
+        repository
+        review_comments
+        rule
+        rule_message
+        rule_name
+        severity
+        sourcing_policy
+        state
+        state_updated_at
+        status
+        syntactic_id
+        triage_comment
+        triage_reason
+        triage_state
+        triaged_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(assistant: SKIP, categories: SKIP,
+                   click_to_fix_failures: SKIP, click_to_fix_prs: SKIP,
+                   confidence: SKIP, created_at: SKIP, external_ticket: SKIP,
+                   first_seen_scan_id: SKIP, id: SKIP, line_of_code_url: SKIP,
+                   location: SKIP, match_based_id: SKIP, ref: SKIP,
+                   relevant_since: SKIP, repository: SKIP,
+                   review_comments: SKIP, rule: SKIP, rule_message: SKIP,
+                   rule_name: SKIP, severity: SKIP, sourcing_policy: SKIP,
+                   state: SKIP, state_updated_at: SKIP, status: SKIP,
+                   syntactic_id: SKIP, triage_comment: SKIP,
+                   triage_reason: SKIP, triage_state: SKIP, triaged_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @assistant = assistant unless assistant == SKIP
+      @categories = categories unless categories == SKIP
+      @click_to_fix_failures = click_to_fix_failures unless click_to_fix_failures == SKIP
+      @click_to_fix_prs = click_to_fix_prs unless click_to_fix_prs == SKIP
+      @confidence = confidence unless confidence == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @external_ticket = external_ticket unless external_ticket == SKIP
+      @first_seen_scan_id = first_seen_scan_id unless first_seen_scan_id == SKIP
+      @id = id unless id == SKIP
+      @line_of_code_url = line_of_code_url unless line_of_code_url == SKIP
+      @location = location unless location == SKIP
+      @match_based_id = match_based_id unless match_based_id == SKIP
+      @ref = ref unless ref == SKIP
+      @relevant_since = relevant_since unless relevant_since == SKIP
+      @repository = repository unless repository == SKIP
+      @review_comments = review_comments unless review_comments == SKIP
+      @rule = rule unless rule == SKIP
+      @rule_message = rule_message unless rule_message == SKIP
+      @rule_name = rule_name unless rule_name == SKIP
+      @severity = severity unless severity == SKIP
+      @sourcing_policy = sourcing_policy unless sourcing_policy == SKIP
+      @state = state unless state == SKIP
+      @state_updated_at = state_updated_at unless state_updated_at == SKIP
+      @status = status unless status == SKIP
+      @syntactic_id = syntactic_id unless syntactic_id == SKIP
+      @triage_comment = triage_comment unless triage_comment == SKIP
+      @triage_reason = triage_reason unless triage_reason == SKIP
+      @triage_state = triage_state unless triage_state == SKIP
+      @triaged_at = triaged_at unless triaged_at == 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.
+      assistant = Assistant.from_hash(hash['assistant']) if hash['assistant']
+      categories = hash.key?('categories') ? hash['categories'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      click_to_fix_failures = nil
+      unless hash['click_to_fix_failures'].nil?
+        click_to_fix_failures = []
+        hash['click_to_fix_failures'].each do |structure|
+          click_to_fix_failures << (ClickToFixFailure.from_hash(structure) if structure)
+        end
+      end
+
+      click_to_fix_failures = SKIP unless hash.key?('click_to_fix_failures')
+      # Parameter is an array, so we need to iterate through it
+      click_to_fix_prs = nil
+      unless hash['click_to_fix_prs'].nil?
+        click_to_fix_prs = []
+        hash['click_to_fix_prs'].each do |structure|
+          click_to_fix_prs << (ClickToFixPr.from_hash(structure) if structure)
+        end
+      end
+
+      click_to_fix_prs = SKIP unless hash.key?('click_to_fix_prs')
+      confidence = hash.key?('confidence') ? hash['confidence'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      external_ticket = ExternalTicket.from_hash(hash['external_ticket']) if
+        hash['external_ticket']
+      first_seen_scan_id =
+        hash.key?('first_seen_scan_id') ? hash['first_seen_scan_id'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      line_of_code_url =
+        hash.key?('line_of_code_url') ? hash['line_of_code_url'] : SKIP
+      location = FindingLocation.from_hash(hash['location']) if hash['location']
+      match_based_id =
+        hash.key?('match_based_id') ? hash['match_based_id'] : SKIP
+      ref = hash.key?('ref') ? hash['ref'] : SKIP
+      relevant_since =
+        hash.key?('relevant_since') ? hash['relevant_since'] : SKIP
+      repository = FindingRepository.from_hash(hash['repository']) if hash['repository']
+      # Parameter is an array, so we need to iterate through it
+      review_comments = nil
+      unless hash['review_comments'].nil?
+        review_comments = []
+        hash['review_comments'].each do |structure|
+          review_comments << (ReviewComment.from_hash(structure) if structure)
+        end
+      end
+
+      review_comments = SKIP unless hash.key?('review_comments')
+      rule = FindingRule.from_hash(hash['rule']) if hash['rule']
+      rule_message = hash.key?('rule_message') ? hash['rule_message'] : SKIP
+      rule_name = hash.key?('rule_name') ? hash['rule_name'] : SKIP
+      severity = hash.key?('severity') ? hash['severity'] : SKIP
+      sourcing_policy = PolicyReference.from_hash(hash['sourcing_policy']) if
+        hash['sourcing_policy']
+      state = hash.key?('state') ? hash['state'] : SKIP
+      state_updated_at =
+        hash.key?('state_updated_at') ? hash['state_updated_at'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      syntactic_id = hash.key?('syntactic_id') ? hash['syntactic_id'] : SKIP
+      triage_comment =
+        hash.key?('triage_comment') ? hash['triage_comment'] : SKIP
+      triage_reason = hash.key?('triage_reason') ? hash['triage_reason'] : SKIP
+      triage_state = hash.key?('triage_state') ? hash['triage_state'] : SKIP
+      triaged_at = hash.key?('triaged_at') ? hash['triaged_at'] : 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.
+      SastFinding.new(assistant: assistant,
+                      categories: categories,
+                      click_to_fix_failures: click_to_fix_failures,
+                      click_to_fix_prs: click_to_fix_prs,
+                      confidence: confidence,
+                      created_at: created_at,
+                      external_ticket: external_ticket,
+                      first_seen_scan_id: first_seen_scan_id,
+                      id: id,
+                      line_of_code_url: line_of_code_url,
+                      location: location,
+                      match_based_id: match_based_id,
+                      ref: ref,
+                      relevant_since: relevant_since,
+                      repository: repository,
+                      review_comments: review_comments,
+                      rule: rule,
+                      rule_message: rule_message,
+                      rule_name: rule_name,
+                      severity: severity,
+                      sourcing_policy: sourcing_policy,
+                      state: state,
+                      state_updated_at: state_updated_at,
+                      status: status,
+                      syntactic_id: syntactic_id,
+                      triage_comment: triage_comment,
+                      triage_reason: triage_reason,
+                      triage_state: triage_state,
+                      triaged_at: triaged_at,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SastFinding | 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} assistant: #{@assistant}, categories: #{@categories},"\
+      " click_to_fix_failures: #{@click_to_fix_failures}, click_to_fix_prs: #{@click_to_fix_prs},"\
+      " confidence: #{@confidence}, created_at: #{@created_at}, external_ticket:"\
+      " #{@external_ticket}, first_seen_scan_id: #{@first_seen_scan_id}, id: #{@id},"\
+      " line_of_code_url: #{@line_of_code_url}, location: #{@location}, match_based_id:"\
+      " #{@match_based_id}, ref: #{@ref}, relevant_since: #{@relevant_since}, repository:"\
+      " #{@repository}, review_comments: #{@review_comments}, rule: #{@rule}, rule_message:"\
+      " #{@rule_message}, rule_name: #{@rule_name}, severity: #{@severity}, sourcing_policy:"\
+      " #{@sourcing_policy}, state: #{@state}, state_updated_at: #{@state_updated_at}, status:"\
+      " #{@status}, syntactic_id: #{@syntactic_id}, triage_comment: #{@triage_comment},"\
+      " triage_reason: #{@triage_reason}, triage_state: #{@triage_state}, triaged_at:"\
+      " #{@triaged_at}, 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} assistant: #{@assistant.inspect}, categories: #{@categories.inspect},"\
+      " click_to_fix_failures: #{@click_to_fix_failures.inspect}, click_to_fix_prs:"\
+      " #{@click_to_fix_prs.inspect}, confidence: #{@confidence.inspect}, created_at:"\
+      " #{@created_at.inspect}, external_ticket: #{@external_ticket.inspect}, first_seen_scan_id:"\
+      " #{@first_seen_scan_id.inspect}, id: #{@id.inspect}, line_of_code_url:"\
+      " #{@line_of_code_url.inspect}, location: #{@location.inspect}, match_based_id:"\
+      " #{@match_based_id.inspect}, ref: #{@ref.inspect}, relevant_since:"\
+      " #{@relevant_since.inspect}, repository: #{@repository.inspect}, review_comments:"\
+      " #{@review_comments.inspect}, rule: #{@rule.inspect}, rule_message:"\
+      " #{@rule_message.inspect}, rule_name: #{@rule_name.inspect}, severity:"\
+      " #{@severity.inspect}, sourcing_policy: #{@sourcing_policy.inspect}, state:"\
+      " #{@state.inspect}, state_updated_at: #{@state_updated_at.inspect}, status:"\
+      " #{@status.inspect}, syntactic_id: #{@syntactic_id.inspect}, triage_comment:"\
+      " #{@triage_comment.inspect}, triage_reason: #{@triage_reason.inspect}, triage_state:"\
+      " #{@triage_state.inspect}, triaged_at: #{@triaged_at.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/sast_findings.rb

@@ -0,0 +1,84 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # A list of Code findings that Semgrep has identified in your organization
+  class SastFindings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of Code findings.
+    # @return [Array[SastFinding]]
+    attr_accessor :findings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['findings'] = 'findings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        findings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(findings: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @findings = findings unless findings == 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.
+      # Parameter is an array, so we need to iterate through it
+      findings = nil
+      unless hash['findings'].nil?
+        findings = []
+        hash['findings'].each do |structure|
+          findings << (SastFinding.from_hash(structure) if structure)
+        end
+      end
+
+      findings = SKIP unless hash.key?('findings')
+
+      # 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.
+      SastFindings.new(findings: findings,
+                       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} findings: #{@findings}, 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} findings: #{@findings.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/sbom_output_format.rb

@@ -0,0 +1,37 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # SBOM output format for the SBOM export. | value | description |
+  # |-------|---------------| | SBOM_OUTPUT_FORMAT_JSON |  |
+  class SbomOutputFormat
+    SBOM_OUTPUT_FORMAT = [
+      # TODO: Write general description for SBOM_OUTPUT_FORMAT_JSON
+      SBOM_OUTPUT_FORMAT_JSON = 'SBOM_OUTPUT_FORMAT_JSON'.freeze,
+
+      # TODO: Write general description for SBOM_OUTPUT_FORMAT_CYCLONEDX
+      SBOM_OUTPUT_FORMAT_CYCLONEDX = 'SBOM_OUTPUT_FORMAT_CYCLONEDX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SBOM_OUTPUT_FORMAT.include?(value)
+    end
+
+    def self.from_value(value, default_value = SBOM_OUTPUT_FORMAT_JSON)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sbom_output_format_json' then SBOM_OUTPUT_FORMAT_JSON
+      when 'sbom_output_format_cyclonedx' then SBOM_OUTPUT_FORMAT_CYCLONEDX
+      else
+        default_value
+      end
+    end
+  end
+end