apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/ecosystem.rb

@@ -0,0 +1,91 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Filter by ecosystem (e.g. npm, pypi, etc). | value | description |
+  # |-------|---------------| | no_package_manager |  | | npm |  | | pypi |  | |
+  # gomod |  | | cargo |  | | maven |  | | gem |  | | composer |  | | nuget |  |
+  # | pub |  | | swiftpm |  | | hex |  | | cocoapods |  | | mix |  | | opam |  |
+  class Ecosystem
+    ECOSYSTEM = [
+      # TODO: Write general description for NO_PACKAGE_MANAGER
+      NO_PACKAGE_MANAGER = 'no_package_manager'.freeze,
+
+      # TODO: Write general description for NPM
+      NPM = 'npm'.freeze,
+
+      # TODO: Write general description for PYPI
+      PYPI = 'pypi'.freeze,
+
+      # TODO: Write general description for GOMOD
+      GOMOD = 'gomod'.freeze,
+
+      # TODO: Write general description for CARGO
+      CARGO = 'cargo'.freeze,
+
+      # TODO: Write general description for MAVEN
+      MAVEN = 'maven'.freeze,
+
+      # TODO: Write general description for GEM
+      GEM = 'gem'.freeze,
+
+      # TODO: Write general description for COMPOSER
+      COMPOSER = 'composer'.freeze,
+
+      # TODO: Write general description for NUGET
+      NUGET = 'nuget'.freeze,
+
+      # TODO: Write general description for PUB
+      PUB = 'pub'.freeze,
+
+      # TODO: Write general description for SWIFTPM
+      SWIFTPM = 'swiftpm'.freeze,
+
+      # TODO: Write general description for HEX
+      HEX = 'hex'.freeze,
+
+      # TODO: Write general description for COCOAPODS
+      COCOAPODS = 'cocoapods'.freeze,
+
+      # TODO: Write general description for MIX
+      MIX = 'mix'.freeze,
+
+      # TODO: Write general description for OPAM
+      OPAM = 'opam'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ECOSYSTEM.include?(value)
+    end
+
+    def self.from_value(value, default_value = NO_PACKAGE_MANAGER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'no_package_manager' then NO_PACKAGE_MANAGER
+      when 'npm' then NPM
+      when 'pypi' then PYPI
+      when 'gomod' then GOMOD
+      when 'cargo' then CARGO
+      when 'maven' then MAVEN
+      when 'gem' then GEM
+      when 'composer' then COMPOSER
+      when 'nuget' then NUGET
+      when 'pub' then PUB
+      when 'swiftpm' then SWIFTPM
+      when 'hex' then HEX
+      when 'cocoapods' then COCOAPODS
+      when 'mix' then MIX
+      when 'opam' then OPAM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/ecosystem1.rb

@@ -0,0 +1,92 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # The ecosystem the dependency is in (e.g. pypi, npm, etc). | value |
+  # description | |-------|---------------| | no_package_manager |  | | npm |  |
+  # | pypi |  | | gomod |  | | cargo |  | | maven |  | | gem |  | | composer |
+  # | | nuget |  | | pub |  | | swiftpm |  | | hex |  | | cocoapods |  | | mix |
+  #  | | opam |  |
+  class Ecosystem1
+    ECOSYSTEM1 = [
+      # TODO: Write general description for NO_PACKAGE_MANAGER
+      NO_PACKAGE_MANAGER = 'no_package_manager'.freeze,
+
+      # TODO: Write general description for NPM
+      NPM = 'npm'.freeze,
+
+      # TODO: Write general description for PYPI
+      PYPI = 'pypi'.freeze,
+
+      # TODO: Write general description for GOMOD
+      GOMOD = 'gomod'.freeze,
+
+      # TODO: Write general description for CARGO
+      CARGO = 'cargo'.freeze,
+
+      # TODO: Write general description for MAVEN
+      MAVEN = 'maven'.freeze,
+
+      # TODO: Write general description for GEM
+      GEM = 'gem'.freeze,
+
+      # TODO: Write general description for COMPOSER
+      COMPOSER = 'composer'.freeze,
+
+      # TODO: Write general description for NUGET
+      NUGET = 'nuget'.freeze,
+
+      # TODO: Write general description for PUB
+      PUB = 'pub'.freeze,
+
+      # TODO: Write general description for SWIFTPM
+      SWIFTPM = 'swiftpm'.freeze,
+
+      # TODO: Write general description for HEX
+      HEX = 'hex'.freeze,
+
+      # TODO: Write general description for COCOAPODS
+      COCOAPODS = 'cocoapods'.freeze,
+
+      # TODO: Write general description for MIX
+      MIX = 'mix'.freeze,
+
+      # TODO: Write general description for OPAM
+      OPAM = 'opam'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ECOSYSTEM1.include?(value)
+    end
+
+    def self.from_value(value, default_value = NO_PACKAGE_MANAGER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'no_package_manager' then NO_PACKAGE_MANAGER
+      when 'npm' then NPM
+      when 'pypi' then PYPI
+      when 'gomod' then GOMOD
+      when 'cargo' then CARGO
+      when 'maven' then MAVEN
+      when 'gem' then GEM
+      when 'composer' then COMPOSER
+      when 'nuget' then NUGET
+      when 'pub' then PUB
+      when 'swiftpm' then SWIFTPM
+      when 'hex' then HEX
+      when 'cocoapods' then COCOAPODS
+      when 'mix' then MIX
+      when 'opam' then OPAM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/ecosystem2.rb

@@ -0,0 +1,76 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Ecosystem of the package
+  class Ecosystem2
+    ECOSYSTEM2 = [
+      # TODO: Write general description for NO_PACKAGE_MANAGER
+      NO_PACKAGE_MANAGER = 'no_package_manager'.freeze,
+
+      # TODO: Write general description for NPM
+      NPM = 'npm'.freeze,
+
+      # TODO: Write general description for PYPI
+      PYPI = 'pypi'.freeze,
+
+      # TODO: Write general description for GOMOD
+      GOMOD = 'gomod'.freeze,
+
+      # TODO: Write general description for CARGO
+      CARGO = 'cargo'.freeze,
+
+      # TODO: Write general description for MAVEN
+      MAVEN = 'maven'.freeze,
+
+      # TODO: Write general description for GEM
+      GEM = 'gem'.freeze,
+
+      # TODO: Write general description for COMPOSER
+      COMPOSER = 'composer'.freeze,
+
+      # TODO: Write general description for NUGET
+      NUGET = 'nuget'.freeze,
+
+      # TODO: Write general description for PUB
+      PUB = 'pub'.freeze,
+
+      # TODO: Write general description for SWIFTPM
+      SWIFTPM = 'swiftpm'.freeze,
+
+      # TODO: Write general description for HEX
+      HEX = 'hex'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ECOSYSTEM2.include?(value)
+    end
+
+    def self.from_value(value, default_value = NO_PACKAGE_MANAGER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'no_package_manager' then NO_PACKAGE_MANAGER
+      when 'npm' then NPM
+      when 'pypi' then PYPI
+      when 'gomod' then GOMOD
+      when 'cargo' then CARGO
+      when 'maven' then MAVEN
+      when 'gem' then GEM
+      when 'composer' then COMPOSER
+      when 'nuget' then NUGET
+      when 'pub' then PUB
+      when 'swiftpm' then SWIFTPM
+      when 'hex' then HEX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/endpoint_reference.rb

@@ -0,0 +1,72 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # EndpointReference Model.
+  class EndpointReference < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL that the reference is pointing to.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(url:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @url = url
+      @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.
+      url = hash.key?('url') ? hash['url'] : nil
+
+      # 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.
+      EndpointReference.new(url: url,
+                            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} 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} url: #{@url.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/epss_probability.rb

@@ -0,0 +1,45 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Filter by EPSS probability (likelihood of exploit). Only applies for sca
+  # findings.
+  class EpssProbability
+    EPSS_PROBABILITY = [
+      # 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 NONE
+      NONE = 'none'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EPSS_PROBABILITY.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 'none' then NONE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/epss_score.rb

@@ -0,0 +1,95 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # The score assigned by FIRST.org's Exploitation Probability Scoring System
+  class EpssScore < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This EPSS score's percentile among all EPSS scores, from 0 to 1
+    # @return [Float]
+    attr_accessor :percentile
+
+    # The explotation probability, from 0 to 1
+    # @return [Float]
+    attr_accessor :score
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['percentile'] = 'percentile'
+      @_hash['score'] = 'score'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        percentile
+        score
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(percentile: SKIP, score: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @percentile = percentile unless percentile == SKIP
+      @score = score unless score == 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.
+      percentile = hash.key?('percentile') ? hash['percentile'] : SKIP
+      score = hash.key?('score') ? hash['score'] : 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.
+      EpssScore.new(percentile: percentile,
+                    score: score,
+                    additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [EpssScore | 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} percentile: #{@percentile}, score: #{@score}, 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} percentile: #{@percentile.inspect}, score: #{@score.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/exposures.rb

@@ -0,0 +1,50 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Filter by exposure (reachability type). Only applies for sca findings.
+  # Reachability is the ability of an attacker to access a vulnerability in a
+  # system.
+  class Exposures
+    EXPOSURES = [
+      # TODO: Write general description for REACHABLE
+      REACHABLE = 'reachable'.freeze,
+
+      # TODO: Write general description for ALWAYS_REACHABLE
+      ALWAYS_REACHABLE = 'always_reachable'.freeze,
+
+      # TODO: Write general description for CONDITIONALLY_REACHABLE
+      CONDITIONALLY_REACHABLE = 'conditionally_reachable'.freeze,
+
+      # TODO: Write general description for UNREACHABLE
+      UNREACHABLE = 'unreachable'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXPOSURES.include?(value)
+    end
+
+    def self.from_value(value, default_value = REACHABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'reachable' then REACHABLE
+      when 'always_reachable' then ALWAYS_REACHABLE
+      when 'conditionally_reachable' then CONDITIONALLY_REACHABLE
+      when 'unreachable' then UNREACHABLE
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/exposures2.rb

@@ -0,0 +1,51 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # List of exposures or reachability types to filter by. If not specified,
+  # returns findings across all exposures. This filter is applicable when
+  # `issue_type=sca` is specified. Valid values: reachable, always_reachable,
+  # conditionally_reachable, unreachable, unknown
+  class Exposures2
+    EXPOSURES2 = [
+      # TODO: Write general description for REACHABLE
+      REACHABLE = 'reachable'.freeze,
+
+      # TODO: Write general description for ALWAYS_REACHABLE
+      ALWAYS_REACHABLE = 'always_reachable'.freeze,
+
+      # TODO: Write general description for CONDITIONALLY_REACHABLE
+      CONDITIONALLY_REACHABLE = 'conditionally_reachable'.freeze,
+
+      # TODO: Write general description for UNREACHABLE
+      UNREACHABLE = 'unreachable'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXPOSURES2.include?(value)
+    end
+
+    def self.from_value(value, default_value = REACHABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'reachable' then REACHABLE
+      when 'always_reachable' then ALWAYS_REACHABLE
+      when 'conditionally_reachable' then CONDITIONALLY_REACHABLE
+      when 'unreachable' then UNREACHABLE
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/external_ticket.rb

@@ -0,0 +1,116 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # External ticket associated with finding
+  class ExternalTicket < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the external ticket
+    # @return [String]
+    attr_accessor :external_slug
+
+    # External ticket id
+    # @return [Integer]
+    attr_accessor :id
+
+    # Semgrep issue ids that are linked to this external ticket
+    # @return [Array[Integer]]
+    attr_accessor :linked_issue_ids
+
+    # URL of the external ticket
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_slug'] = 'external_slug'
+      @_hash['id'] = 'id'
+      @_hash['linked_issue_ids'] = 'linked_issue_ids'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_slug
+        id
+        linked_issue_ids
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_slug: SKIP, id: SKIP, linked_issue_ids: SKIP,
+                   url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @external_slug = external_slug unless external_slug == SKIP
+      @id = id unless id == SKIP
+      @linked_issue_ids = linked_issue_ids unless linked_issue_ids == 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.
+      external_slug = hash.key?('external_slug') ? hash['external_slug'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      linked_issue_ids =
+        hash.key?('linked_issue_ids') ? hash['linked_issue_ids'] : 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.
+      ExternalTicket.new(external_slug: external_slug,
+                         id: id,
+                         linked_issue_ids: linked_issue_ids,
+                         url: url,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ExternalTicket | 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_slug: #{@external_slug}, id: #{@id}, linked_issue_ids:"\
+      " #{@linked_issue_ids}, 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} external_slug: #{@external_slug.inspect}, id: #{@id.inspect},"\
+      " linked_issue_ids: #{@linked_issue_ids.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end