apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/click_to_fix_pr_state.rb

@@ -0,0 +1,38 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Filter findings by Click-to-Fix PR state. If not specified, returns all
+  # findings regardless of autofix PR status. This filter applies to both sast
+  # and sca issue types. Valid values: open, merged
+  class ClickToFixPrState
+    CLICK_TO_FIX_PR_STATE = [
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze,
+
+      # TODO: Write general description for MERGED
+      MERGED = 'merged'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CLICK_TO_FIX_PR_STATE.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 'merged' then MERGED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/component.rb

@@ -0,0 +1,95 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Semgrep Assistant's guess as for what the matched source code's purpose is
+  class Component < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Component risk level
+    # @return [Risk]
+    attr_accessor :risk
+
+    # Component tag
+    # @return [String]
+    attr_accessor :tag
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['risk'] = 'risk'
+      @_hash['tag'] = 'tag'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        risk
+        tag
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(risk: SKIP, tag: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @risk = risk unless risk == SKIP
+      @tag = tag unless tag == 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.
+      risk = hash.key?('risk') ? hash['risk'] : SKIP
+      tag = hash.key?('tag') ? hash['tag'] : 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.
+      Component.new(risk: risk,
+                    tag: tag,
+                    additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Component | 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} risk: #{@risk}, tag: #{@tag}, 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} risk: #{@risk.inspect}, tag: #{@tag.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/confidence.rb

@@ -0,0 +1,42 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Confidence based on the Rule's false-positive rate. | value | description |
+  # |-------|---------------| | CONFIDENCE_HIGH |  | | CONFIDENCE_MEDIUM |  | |
+  # CONFIDENCE_LOW |  |
+  class Confidence
+    CONFIDENCE = [
+      # TODO: Write general description for CONFIDENCE_HIGH
+      CONFIDENCE_HIGH = 'CONFIDENCE_HIGH'.freeze,
+
+      # TODO: Write general description for CONFIDENCE_MEDIUM
+      CONFIDENCE_MEDIUM = 'CONFIDENCE_MEDIUM'.freeze,
+
+      # TODO: Write general description for CONFIDENCE_LOW
+      CONFIDENCE_LOW = 'CONFIDENCE_LOW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONFIDENCE.include?(value)
+    end
+
+    def self.from_value(value, default_value = CONFIDENCE_HIGH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'confidence_high' then CONFIDENCE_HIGH
+      when 'confidence_medium' then CONFIDENCE_MEDIUM
+      when 'confidence_low' then CONFIDENCE_LOW
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/confidence1.rb

@@ -0,0 +1,40 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Confidence of the finding, derived from the rule that triggered it
+  class Confidence1
+    CONFIDENCE1 = [
+      # 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
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONFIDENCE1.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
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/confidence2.rb

@@ -0,0 +1,40 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Confidence level of the rule
+  class Confidence2
+    CONFIDENCE2 = [
+      # 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
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONFIDENCE2.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
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/confidence3.rb

@@ -0,0 +1,40 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # List of confidence levels to filter by
+  class Confidence3
+    CONFIDENCE3 = [
+      # 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
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONFIDENCE3.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
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/confidence7.rb

@@ -0,0 +1,41 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Confidence of the finding. | value | description | |-------|---------------|
+  # | CONFIDENCE_HIGH |  | | CONFIDENCE_MEDIUM |  | | CONFIDENCE_LOW |  |
+  class Confidence7
+    CONFIDENCE7 = [
+      # TODO: Write general description for CONFIDENCE_HIGH
+      CONFIDENCE_HIGH = 'CONFIDENCE_HIGH'.freeze,
+
+      # TODO: Write general description for CONFIDENCE_MEDIUM
+      CONFIDENCE_MEDIUM = 'CONFIDENCE_MEDIUM'.freeze,
+
+      # TODO: Write general description for CONFIDENCE_LOW
+      CONFIDENCE_LOW = 'CONFIDENCE_LOW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONFIDENCE7.include?(value)
+    end
+
+    def self.from_value(value, default_value = CONFIDENCE_HIGH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'confidence_high' then CONFIDENCE_HIGH
+      when 'confidence_medium' then CONFIDENCE_MEDIUM
+      when 'confidence_low' then CONFIDENCE_LOW
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/confidence8.rb

@@ -0,0 +1,42 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Which rule confidence level do you want to include? If not specified,
+  # includes all. This filter is applicable when `issue_type` is `sast` or
+  # unspecified. Valid values: low, medium, high
+  class Confidence8
+    CONFIDENCE8 = [
+      # 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
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONFIDENCE8.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
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/create_sbom_export_request.rb

@@ -0,0 +1,176 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # CreateSbomExportRequest Model.
+  class CreateSbomExportRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Deployment ID (numeric). Example: `123`. Can be found at `/deployments`,
+    # or in your Settings in the web UI.
+    # @return [String]
+    attr_accessor :deployment_id
+
+    # Deployment ID (numeric). Example: `123`. Can be found at `/deployments`,
+    # or in your Settings in the web UI.
+    # @return [ProtosScaV1SbomFormatVersion]
+    attr_accessor :format_version
+
+    # Metadata component type for the SBOM export.
+    # | value | description |
+    # |-------|---------------|
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FRAMEWORK |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_LIBRARY |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_CONTAINER |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_PLATFORM |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_OPERATING_SYSTEM |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE_DRIVER |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FIRMWARE |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FILE |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_MACHINE_LEARNING_MODEL |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DATA |  |
+    # @return [MetadataComponentType]
+    attr_accessor :metadata_component_type
+
+    # Metadata component type for the SBOM export.
+    # | value | description |
+    # |-------|---------------|
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FRAMEWORK |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_LIBRARY |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_CONTAINER |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_PLATFORM |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_OPERATING_SYSTEM |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE_DRIVER |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FIRMWARE |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FILE |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_MACHINE_LEARNING_MODEL |  |
+    # | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DATA |  |
+    # @return [ProtosScaV1SbomMetadataSupplier]
+    attr_accessor :metadata_supplier
+
+    # Branch to export SBOM for (Ex. ref=`refs/pull/1234/merge`).
+    # @return [String]
+    attr_accessor :ref
+
+    # Repository ID to export SBOM for.
+    # @return [String]
+    attr_accessor :repository_id
+
+    # SBOM output format for the SBOM export.
+    # | value | description |
+    # |-------|---------------|
+    # | SBOM_OUTPUT_FORMAT_JSON |  |
+    # @return [SbomOutputFormat]
+    attr_accessor :sbom_output_format
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['deployment_id'] = 'deploymentId'
+      @_hash['format_version'] = 'formatVersion'
+      @_hash['metadata_component_type'] = 'metadataComponentType'
+      @_hash['metadata_supplier'] = 'metadataSupplier'
+      @_hash['ref'] = 'ref'
+      @_hash['repository_id'] = 'repositoryId'
+      @_hash['sbom_output_format'] = 'sbomOutputFormat'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        format_version
+        metadata_component_type
+        metadata_supplier
+        ref
+        repository_id
+        sbom_output_format
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      deployment_id:, format_version: SKIP,
+      metadata_component_type: MetadataComponentType::SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION,
+      metadata_supplier: SKIP, ref: SKIP, repository_id: SKIP,
+      sbom_output_format: SKIP, additional_properties: nil
+    )
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deployment_id = deployment_id
+      @format_version = format_version unless format_version == SKIP
+      @metadata_component_type = metadata_component_type unless metadata_component_type == SKIP
+      @metadata_supplier = metadata_supplier unless metadata_supplier == SKIP
+      @ref = ref unless ref == SKIP
+      @repository_id = repository_id unless repository_id == SKIP
+      @sbom_output_format = sbom_output_format unless sbom_output_format == 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
+      format_version = ProtosScaV1SbomFormatVersion.from_hash(hash['formatVersion']) if
+        hash['formatVersion']
+      metadata_component_type =
+        hash['metadataComponentType'] ||= MetadataComponentType::SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION
+      metadata_supplier = ProtosScaV1SbomMetadataSupplier.from_hash(hash['metadataSupplier']) if
+        hash['metadataSupplier']
+      ref = hash.key?('ref') ? hash['ref'] : SKIP
+      repository_id = hash.key?('repositoryId') ? hash['repositoryId'] : SKIP
+      sbom_output_format =
+        hash.key?('sbomOutputFormat') ? hash['sbomOutputFormat'] : 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.
+      CreateSbomExportRequest.new(deployment_id: deployment_id,
+                                  format_version: format_version,
+                                  metadata_component_type: metadata_component_type,
+                                  metadata_supplier: metadata_supplier,
+                                  ref: ref,
+                                  repository_id: repository_id,
+                                  sbom_output_format: sbom_output_format,
+                                  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} deployment_id: #{@deployment_id}, format_version: #{@format_version},"\
+      " metadata_component_type: #{@metadata_component_type}, metadata_supplier:"\
+      " #{@metadata_supplier}, ref: #{@ref}, repository_id: #{@repository_id}, sbom_output_format:"\
+      " #{@sbom_output_format}, 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} deployment_id: #{@deployment_id.inspect}, format_version:"\
+      " #{@format_version.inspect}, metadata_component_type: #{@metadata_component_type.inspect},"\
+      " metadata_supplier: #{@metadata_supplier.inspect}, ref: #{@ref.inspect}, repository_id:"\
+      " #{@repository_id.inspect}, sbom_output_format: #{@sbom_output_format.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/create_sbom_export_response.rb

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