apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/search_scans_request.rb

@@ -0,0 +1,202 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module SemgrepWebApp
+  # SearchScansRequest Model.
+  class SearchScansRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Only get scans from the specified branch
+    # @return [String]
+    attr_accessor :branch
+
+    # Cursor to paginate through the results
+    # @return [String]
+    attr_accessor :cursor
+
+    # Deployment ID (numeric). Example: `123`. Can be found at `/deployments`,
+    # or in your Settings in the web UI.
+    # @return [String]
+    attr_accessor :deployment_id
+
+    # Only get scans that are full scans (if false, only get diff scans)
+    # @return [Integer]
+    attr_accessor :is_full_scan
+
+    # Page size to paginate through the results (default is 100, max is 500)
+    # @return [Integer]
+    attr_accessor :limit
+
+    # Only get scans that have these enabled products
+    # | value | description |
+    # |-------|---------------|
+    # | PRODUCT_SAST |  |
+    # | PRODUCT_SCA |  |
+    # | PRODUCT_SECRETS |  |
+    # | PRODUCT_AI_SAST |  |
+    # @return [Products]
+    attr_accessor :products
+
+    # Only get scans for this repo
+    # @return [Integer]
+    attr_accessor :repository_id
+
+    # Only get scans created after this time. Provide time in ISO 8601 format.
+    # @return [DateTime]
+    attr_accessor :since
+
+    # Only get scans that have one of these statuses
+    # | value | description |
+    # |-------|---------------|
+    # | SCAN_STATUS_RUNNING | The scan is currently running |
+    # | SCAN_STATUS_COMPLETED | The scan has completed successfully (0 or 1 exit
+    # code) |
+    # | SCAN_STATUS_PENDING | The scan is queued and waiting to start |
+    # | SCAN_STATUS_CANCELLED | The scan was cancelled before completion |
+    # | SCAN_STATUS_ERROR | The scan has exited with a failure (exit code not 0
+    # or 1) |
+    # | SCAN_STATUS_NEVER_FINISHED | The scan did not report an error or success
+    # after over an hour |
+    # @return [Statuses]
+    attr_accessor :statuses
+
+    # Only get scans that have one of these statuses
+    # | value | description |
+    # |-------|---------------|
+    # | SCAN_STATUS_RUNNING | The scan is currently running |
+    # | SCAN_STATUS_COMPLETED | The scan has completed successfully (0 or 1 exit
+    # code) |
+    # | SCAN_STATUS_PENDING | The scan is queued and waiting to start |
+    # | SCAN_STATUS_CANCELLED | The scan was cancelled before completion |
+    # | SCAN_STATUS_ERROR | The scan has exited with a failure (exit code not 0
+    # or 1) |
+    # | SCAN_STATUS_NEVER_FINISHED | The scan did not report an error or success
+    # after over an hour |
+    # @return [FloatRange]
+    attr_accessor :total_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['branch'] = 'branch'
+      @_hash['cursor'] = 'cursor'
+      @_hash['deployment_id'] = 'deploymentId'
+      @_hash['is_full_scan'] = 'is_full_scan'
+      @_hash['limit'] = 'limit'
+      @_hash['products'] = 'products'
+      @_hash['repository_id'] = 'repository_id'
+      @_hash['since'] = 'since'
+      @_hash['statuses'] = 'statuses'
+      @_hash['total_time'] = 'total_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        branch
+        cursor
+        is_full_scan
+        limit
+        products
+        repository_id
+        since
+        statuses
+        total_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(deployment_id:, branch: SKIP, cursor: SKIP,
+                   is_full_scan: SKIP, limit: SKIP, products: SKIP,
+                   repository_id: SKIP, since: SKIP, statuses: SKIP,
+                   total_time: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @branch = branch unless branch == SKIP
+      @cursor = cursor unless cursor == SKIP
+      @deployment_id = deployment_id
+      @is_full_scan = is_full_scan unless is_full_scan == SKIP
+      @limit = limit unless limit == SKIP
+      @products = products unless products == SKIP
+      @repository_id = repository_id unless repository_id == SKIP
+      @since = since unless since == SKIP
+      @statuses = statuses unless statuses == SKIP
+      @total_time = total_time unless total_time == 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.
+      deployment_id = hash.key?('deploymentId') ? hash['deploymentId'] : nil
+      branch = hash.key?('branch') ? hash['branch'] : SKIP
+      cursor = hash.key?('cursor') ? hash['cursor'] : SKIP
+      is_full_scan = hash.key?('is_full_scan') ? hash['is_full_scan'] : SKIP
+      limit = hash.key?('limit') ? hash['limit'] : SKIP
+      products = hash.key?('products') ? hash['products'] : SKIP
+      repository_id = hash.key?('repository_id') ? hash['repository_id'] : SKIP
+      since = if hash.key?('since')
+                (DateTimeHelper.from_rfc3339(hash['since']) if hash['since'])
+              else
+                SKIP
+              end
+      statuses = hash.key?('statuses') ? hash['statuses'] : SKIP
+      total_time = FloatRange.from_hash(hash['total_time']) if hash['total_time']
+
+      # 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.
+      SearchScansRequest.new(deployment_id: deployment_id,
+                             branch: branch,
+                             cursor: cursor,
+                             is_full_scan: is_full_scan,
+                             limit: limit,
+                             products: products,
+                             repository_id: repository_id,
+                             since: since,
+                             statuses: statuses,
+                             total_time: total_time,
+                             additional_properties: additional_properties)
+    end
+
+    def to_custom_since
+      DateTimeHelper.to_rfc3339(since)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} branch: #{@branch}, cursor: #{@cursor}, deployment_id: #{@deployment_id},"\
+      " is_full_scan: #{@is_full_scan}, limit: #{@limit}, products: #{@products}, repository_id:"\
+      " #{@repository_id}, since: #{@since}, statuses: #{@statuses}, total_time: #{@total_time},"\
+      " 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} branch: #{@branch.inspect}, cursor: #{@cursor.inspect}, deployment_id:"\
+      " #{@deployment_id.inspect}, is_full_scan: #{@is_full_scan.inspect}, limit:"\
+      " #{@limit.inspect}, products: #{@products.inspect}, repository_id:"\
+      " #{@repository_id.inspect}, since: #{@since.inspect}, statuses: #{@statuses.inspect},"\
+      " total_time: #{@total_time.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/severities.rb

@@ -0,0 +1,44 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # List of severities to filter by
+  class Severities
+    SEVERITIES = [
+      # TODO: Write general description for LOW
+      LOW = 'low'.freeze,
+
+      # TODO: Write general description for MEDIUM
+      MEDIUM = 'medium'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'high'.freeze,
+
+      # TODO: Write general description for CRITICAL
+      CRITICAL = 'critical'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SEVERITIES.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'medium' then MEDIUM
+      when 'high' then HIGH
+      when 'critical' then CRITICAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/severities2.rb

@@ -0,0 +1,45 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # What severities of issues do you want to include? If not specified, returns
+  # all. Valid values: low, medium, high, critical
+  class Severities2
+    SEVERITIES2 = [
+      # TODO: Write general description for LOW
+      LOW = 'low'.freeze,
+
+      # TODO: Write general description for MEDIUM
+      MEDIUM = 'medium'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'high'.freeze,
+
+      # TODO: Write general description for CRITICAL
+      CRITICAL = 'critical'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SEVERITIES2.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'medium' then MEDIUM
+      when 'high' then HIGH
+      when 'critical' then CRITICAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/severity.rb

@@ -0,0 +1,46 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Severity level ("seriousness" of the finding) | value | description |
+  # |-------|---------------| | SEVERITY_HIGH |  | | SEVERITY_MEDIUM |  | |
+  # SEVERITY_LOW |  | | SEVERITY_CRITICAL |  |
+  class Severity
+    SEVERITY = [
+      # TODO: Write general description for SEVERITY_HIGH
+      SEVERITY_HIGH = 'SEVERITY_HIGH'.freeze,
+
+      # TODO: Write general description for SEVERITY_MEDIUM
+      SEVERITY_MEDIUM = 'SEVERITY_MEDIUM'.freeze,
+
+      # TODO: Write general description for SEVERITY_LOW
+      SEVERITY_LOW = 'SEVERITY_LOW'.freeze,
+
+      # TODO: Write general description for SEVERITY_CRITICAL
+      SEVERITY_CRITICAL = 'SEVERITY_CRITICAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SEVERITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = SEVERITY_HIGH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'severity_high' then SEVERITY_HIGH
+      when 'severity_medium' then SEVERITY_MEDIUM
+      when 'severity_low' then SEVERITY_LOW
+      when 'severity_critical' then SEVERITY_CRITICAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/severity1.rb

@@ -0,0 +1,45 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Severity of the finding, derived from the rule that triggered it. Low is
+  # equivalent to INFO, Medium to WARNING, and High to ERROR
+  class Severity1
+    SEVERITY1 = [
+      # TODO: Write general description for LOW
+      LOW = 'low'.freeze,
+
+      # TODO: Write general description for MEDIUM
+      MEDIUM = 'medium'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'high'.freeze,
+
+      # TODO: Write general description for CRITICAL
+      CRITICAL = 'critical'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SEVERITY1.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'medium' then MEDIUM
+      when 'high' then HIGH
+      when 'critical' then CRITICAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/severity4.rb

@@ -0,0 +1,46 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Severity of the finding. | value | description | |-------|---------------| |
+  # SEVERITY_HIGH |  | | SEVERITY_MEDIUM |  | | SEVERITY_LOW |  | |
+  # SEVERITY_CRITICAL |  |
+  class Severity4
+    SEVERITY4 = [
+      # TODO: Write general description for SEVERITY_HIGH
+      SEVERITY_HIGH = 'SEVERITY_HIGH'.freeze,
+
+      # TODO: Write general description for SEVERITY_MEDIUM
+      SEVERITY_MEDIUM = 'SEVERITY_MEDIUM'.freeze,
+
+      # TODO: Write general description for SEVERITY_LOW
+      SEVERITY_LOW = 'SEVERITY_LOW'.freeze,
+
+      # TODO: Write general description for SEVERITY_CRITICAL
+      SEVERITY_CRITICAL = 'SEVERITY_CRITICAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SEVERITY4.include?(value)
+    end
+
+    def self.from_value(value, default_value = SEVERITY_HIGH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'severity_high' then SEVERITY_HIGH
+      when 'severity_medium' then SEVERITY_MEDIUM
+      when 'severity_low' then SEVERITY_LOW
+      when 'severity_critical' then SEVERITY_CRITICAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/severity5.rb

@@ -0,0 +1,48 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # severity5.
+  class Severity5
+    SEVERITY5 = [
+      # TODO: Write general description for SEVERITY_UNSPECIFIED
+      SEVERITY_UNSPECIFIED = 'SEVERITY_UNSPECIFIED'.freeze,
+
+      # TODO: Write general description for SEVERITY_HIGH
+      SEVERITY_HIGH = 'SEVERITY_HIGH'.freeze,
+
+      # TODO: Write general description for SEVERITY_MEDIUM
+      SEVERITY_MEDIUM = 'SEVERITY_MEDIUM'.freeze,
+
+      # TODO: Write general description for SEVERITY_LOW
+      SEVERITY_LOW = 'SEVERITY_LOW'.freeze,
+
+      # TODO: Write general description for SEVERITY_CRITICAL
+      SEVERITY_CRITICAL = 'SEVERITY_CRITICAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SEVERITY5.include?(value)
+    end
+
+    def self.from_value(value, default_value = SEVERITY_UNSPECIFIED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'severity_unspecified' then SEVERITY_UNSPECIFIED
+      when 'severity_high' then SEVERITY_HIGH
+      when 'severity_medium' then SEVERITY_MEDIUM
+      when 'severity_low' then SEVERITY_LOW
+      when 'severity_critical' then SEVERITY_CRITICAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/source.rb

@@ -0,0 +1,42 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Source of the Rule | value | description | |-------|---------------| |
+  # SOURCE_PRO | From Pro rules | | SOURCE_COMMUNITY | From Semgrep Community
+  # rules | | SOURCE_CUSTOM | From Custom rules |
+  class Source
+    SOURCE = [
+      # TODO: Write general description for SOURCE_PRO
+      SOURCE_PRO = 'SOURCE_PRO'.freeze,
+
+      # TODO: Write general description for SOURCE_COMMUNITY
+      SOURCE_COMMUNITY = 'SOURCE_COMMUNITY'.freeze,
+
+      # TODO: Write general description for SOURCE_CUSTOM
+      SOURCE_CUSTOM = 'SOURCE_CUSTOM'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SOURCE.include?(value)
+    end
+
+    def self.from_value(value, default_value = SOURCE_PRO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'source_pro' then SOURCE_PRO
+      when 'source_community' then SOURCE_COMMUNITY
+      when 'source_custom' then SOURCE_CUSTOM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/state.rb

@@ -0,0 +1,42 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # 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
+  class State
+    STATE = [
+      # TODO: Write general description for FIXED
+      FIXED = 'fixed'.freeze,
+
+      # TODO: Write general description for MUTED
+      MUTED = 'muted'.freeze,
+
+      # TODO: Write general description for UNRESOLVED
+      UNRESOLVED = 'unresolved'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATE.include?(value)
+    end
+
+    def self.from_value(value, default_value = FIXED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fixed' then FIXED
+      when 'muted' then MUTED
+      when 'unresolved' then UNRESOLVED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/status.rb

@@ -0,0 +1,55 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # 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
+  class Status
+    STATUS = [
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze,
+
+      # TODO: Write general description for FIXED
+      FIXED = 'fixed'.freeze,
+
+      # TODO: Write general description for IGNORED
+      IGNORED = 'ignored'.freeze,
+
+      # TODO: Write general description for REVIEWING
+      REVIEWING = 'reviewing'.freeze,
+
+      # TODO: Write general description for FIXING
+      FIXING = 'fixing'.freeze,
+
+      # TODO: Write general description for PROVISIONALLY_IGNORED
+      PROVISIONALLY_IGNORED = 'provisionally_ignored'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = OPEN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'open' then OPEN
+      when 'fixed' then FIXED
+      when 'ignored' then IGNORED
+      when 'reviewing' then REVIEWING
+      when 'fixing' then FIXING
+      when 'provisionally_ignored' then PROVISIONALLY_IGNORED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/status1.rb

@@ -0,0 +1,52 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # The status to filter by
+  class Status1
+    STATUS1 = [
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze,
+
+      # TODO: Write general description for FIXED
+      FIXED = 'fixed'.freeze,
+
+      # TODO: Write general description for IGNORED
+      IGNORED = 'ignored'.freeze,
+
+      # TODO: Write general description for REVIEWING
+      REVIEWING = 'reviewing'.freeze,
+
+      # TODO: Write general description for FIXING
+      FIXING = 'fixing'.freeze,
+
+      # TODO: Write general description for PROVISIONALLY_IGNORED
+      PROVISIONALLY_IGNORED = 'provisionally_ignored'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS1.include?(value)
+    end
+
+    def self.from_value(value, default_value = OPEN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'open' then OPEN
+      when 'fixed' then FIXED
+      when 'ignored' then IGNORED
+      when 'reviewing' then REVIEWING
+      when 'fixing' then FIXING
+      when 'provisionally_ignored' then PROVISIONALLY_IGNORED
+      else
+        default_value
+      end
+    end
+  end
+end