apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/usage.rb

@@ -0,0 +1,99 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Usage of the vulnerable package in the codebase. Applies to reachable
+  # findings
+  class Usage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # External ticket associated with finding
+    # @return [ExternalTicket]
+    attr_accessor :external_ticket
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_ticket'] = 'external_ticket'
+      @_hash['location'] = 'location'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_ticket
+        location
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_ticket: SKIP, location: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @external_ticket = external_ticket unless external_ticket == SKIP
+      @location = location unless location == 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_ticket = ExternalTicket.from_hash(hash['external_ticket']) if
+        hash['external_ticket']
+      location = FindingLocation.from_hash(hash['location']) if hash['location']
+
+      # 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.
+      Usage.new(external_ticket: external_ticket,
+                location: location,
+                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Usage | 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_ticket: #{@external_ticket}, location: #{@location},"\
+      " 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_ticket: #{@external_ticket.inspect}, location:"\
+      " #{@location.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/validation_state.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 whether a secret could be validated. Only applies for secrets
+  # findings.
+  class ValidationState
+    VALIDATION_STATE = [
+      # TODO: Write general description for CONFIRMED_VALID
+      CONFIRMED_VALID = 'confirmed_valid'.freeze,
+
+      # TODO: Write general description for CONFIRMED_INVALID
+      CONFIRMED_INVALID = 'confirmed_invalid'.freeze,
+
+      # TODO: Write general description for VALIDATION_ERROR
+      VALIDATION_ERROR = 'validation_error'.freeze,
+
+      # TODO: Write general description for NO_VALIDATOR
+      NO_VALIDATOR = 'no_validator'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VALIDATION_STATE.include?(value)
+    end
+
+    def self.from_value(value, default_value = CONFIRMED_VALID)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'confirmed_valid' then CONFIRMED_VALID
+      when 'confirmed_invalid' then CONFIRMED_INVALID
+      when 'validation_error' then VALIDATION_ERROR
+      when 'no_validator' then NO_VALIDATOR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/validation_state2.rb

@@ -0,0 +1,47 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Whether the finding was validated or not. | value | description |
+  # |-------|---------------| | VALIDATION_STATE_CONFIRMED_VALID |  | |
+  # VALIDATION_STATE_CONFIRMED_INVALID |  | | VALIDATION_STATE_VALIDATION_ERROR
+  # |  | | VALIDATION_STATE_NO_VALIDATOR |  |
+  class ValidationState2
+    VALIDATION_STATE2 = [
+      # TODO: Write general description for VALIDATION_STATE_CONFIRMED_VALID
+      VALIDATION_STATE_CONFIRMED_VALID = 'VALIDATION_STATE_CONFIRMED_VALID'.freeze,
+
+      # TODO: Write general description for VALIDATION_STATE_CONFIRMED_INVALID
+      VALIDATION_STATE_CONFIRMED_INVALID = 'VALIDATION_STATE_CONFIRMED_INVALID'.freeze,
+
+      # TODO: Write general description for VALIDATION_STATE_VALIDATION_ERROR
+      VALIDATION_STATE_VALIDATION_ERROR = 'VALIDATION_STATE_VALIDATION_ERROR'.freeze,
+
+      # TODO: Write general description for VALIDATION_STATE_NO_VALIDATOR
+      VALIDATION_STATE_NO_VALIDATOR = 'VALIDATION_STATE_NO_VALIDATOR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VALIDATION_STATE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = VALIDATION_STATE_CONFIRMED_VALID)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'validation_state_confirmed_valid' then VALIDATION_STATE_CONFIRMED_VALID
+      when 'validation_state_confirmed_invalid' then VALIDATION_STATE_CONFIRMED_INVALID
+      when 'validation_state_validation_error' then VALIDATION_STATE_VALIDATION_ERROR
+      when 'validation_state_no_validator' then VALIDATION_STATE_NO_VALIDATOR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/validation_state3.rb

@@ -0,0 +1,48 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # validationState3.
+  class ValidationState3
+    VALIDATION_STATE3 = [
+      # TODO: Write general description for VALIDATION_STATE_UNSPECIFIED
+      VALIDATION_STATE_UNSPECIFIED = 'VALIDATION_STATE_UNSPECIFIED'.freeze,
+
+      # TODO: Write general description for VALIDATION_STATE_CONFIRMED_VALID
+      VALIDATION_STATE_CONFIRMED_VALID = 'VALIDATION_STATE_CONFIRMED_VALID'.freeze,
+
+      # TODO: Write general description for VALIDATION_STATE_CONFIRMED_INVALID
+      VALIDATION_STATE_CONFIRMED_INVALID = 'VALIDATION_STATE_CONFIRMED_INVALID'.freeze,
+
+      # TODO: Write general description for VALIDATION_STATE_VALIDATION_ERROR
+      VALIDATION_STATE_VALIDATION_ERROR = 'VALIDATION_STATE_VALIDATION_ERROR'.freeze,
+
+      # TODO: Write general description for VALIDATION_STATE_NO_VALIDATOR
+      VALIDATION_STATE_NO_VALIDATOR = 'VALIDATION_STATE_NO_VALIDATOR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VALIDATION_STATE3.include?(value)
+    end
+
+    def self.from_value(value, default_value = VALIDATION_STATE_UNSPECIFIED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'validation_state_unspecified' then VALIDATION_STATE_UNSPECIFIED
+      when 'validation_state_confirmed_valid' then VALIDATION_STATE_CONFIRMED_VALID
+      when 'validation_state_confirmed_invalid' then VALIDATION_STATE_CONFIRMED_INVALID
+      when 'validation_state_validation_error' then VALIDATION_STATE_VALIDATION_ERROR
+      when 'validation_state_no_validator' then VALIDATION_STATE_NO_VALIDATOR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/verdict.rb

@@ -0,0 +1,41 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # | value | description | |-------|---------------| | VERDICT_TRUE_POSITIVE |
+  # | | VERDICT_FALSE_POSITIVE |  | | VERDICT_NO_VERDICT |  |
+  class Verdict
+    VERDICT = [
+      # TODO: Write general description for VERDICT_TRUE_POSITIVE
+      VERDICT_TRUE_POSITIVE = 'VERDICT_TRUE_POSITIVE'.freeze,
+
+      # TODO: Write general description for VERDICT_FALSE_POSITIVE
+      VERDICT_FALSE_POSITIVE = 'VERDICT_FALSE_POSITIVE'.freeze,
+
+      # TODO: Write general description for VERDICT_NO_VERDICT
+      VERDICT_NO_VERDICT = 'VERDICT_NO_VERDICT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERDICT.include?(value)
+    end
+
+    def self.from_value(value, default_value = VERDICT_TRUE_POSITIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'verdict_true_positive' then VERDICT_TRUE_POSITIVE
+      when 'verdict_false_positive' then VERDICT_FALSE_POSITIVE
+      when 'verdict_no_verdict' then VERDICT_NO_VERDICT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/verdict1.rb

@@ -0,0 +1,38 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # The verdict is `true_positive` if Assistant recommends fixing,
+  # `false_positive` if Assistant recommends ignoring this finding. AI generated
+  # decision, review carefully
+  class Verdict1
+    VERDICT1 = [
+      # TODO: Write general description for FALSE_POSITIVE
+      FALSE_POSITIVE = 'false_positive'.freeze,
+
+      # TODO: Write general description for TRUE_POSITIVE
+      TRUE_POSITIVE = 'true_positive'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERDICT1.include?(value)
+    end
+
+    def self.from_value(value, default_value = FALSE_POSITIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'false_positive' then FALSE_POSITIVE
+      when 'true_positive' then TRUE_POSITIVE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/visibility.rb

@@ -0,0 +1,42 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Repository visbility (e.g. public, private, unknown). | value | description
+  # | |-------|---------------| | REPOSITORY_VISIBILITY_PUBLIC |  | |
+  # REPOSITORY_VISIBILITY_PRIVATE |  | | REPOSITORY_VISIBILITY_UNKNOWN |  |
+  class Visibility
+    VISIBILITY = [
+      # TODO: Write general description for REPOSITORY_VISIBILITY_PUBLIC
+      REPOSITORY_VISIBILITY_PUBLIC = 'REPOSITORY_VISIBILITY_PUBLIC'.freeze,
+
+      # TODO: Write general description for REPOSITORY_VISIBILITY_PRIVATE
+      REPOSITORY_VISIBILITY_PRIVATE = 'REPOSITORY_VISIBILITY_PRIVATE'.freeze,
+
+      # TODO: Write general description for REPOSITORY_VISIBILITY_UNKNOWN
+      REPOSITORY_VISIBILITY_UNKNOWN = 'REPOSITORY_VISIBILITY_UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VISIBILITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = REPOSITORY_VISIBILITY_PUBLIC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'repository_visibility_public' then REPOSITORY_VISIBILITY_PUBLIC
+      when 'repository_visibility_private' then REPOSITORY_VISIBILITY_PRIVATE
+      when 'repository_visibility_unknown' then REPOSITORY_VISIBILITY_UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module SemgrepWebApp
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/semgrep_web_app/utilities/file_wrapper.rb

@@ -0,0 +1,28 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file}, content_type: #{@content_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def to_inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file.inspect}, content_type: #{@content_type.inspect}>"
+    end
+  end
+end

data/lib/semgrep_web_app/utilities/union_type_lookup.rb

@@ -0,0 +1,34 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # The `UnionTypeLookUp` class serves as a utility class for
+  # storing and managing type combinator templates. It acts as a container for the templates
+  # used in handling various oneof/anyof instances within the sdk.
+  class UnionTypeLookUp
+    include CoreLibrary
+    # rubocop:disable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+    def self.union_types
+      {
+        :ApiV1DeploymentsFindingsResponseFindings => OneOf.new(
+          [
+            LeafType.new(SastFinding),
+            LeafType.new(ScaFinding),
+            LeafType.new(AiPoweredScanFinding)
+          ],
+          UnionTypeContext.new(
+            is_array: true,
+            is_optional: true
+          )
+        )
+      }
+    end
+    # rubocop:enable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+
+    def self.get(name)
+      UnionTypeLookUp.union_types[name]
+    end
+  end
+end