apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/found_dependency.rb

@@ -0,0 +1,128 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Information about the vulnerable package that was found in the codebase
+  class FoundDependency < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Ecosystem of the package
+    # @return [Ecosystem2]
+    attr_accessor :ecosystem
+
+    # URL to the specific line in the lockfile where the dependency is listed
+    # @return [String]
+    attr_accessor :lockfile_line_url
+
+    # Name of the package that contains the vulnerability
+    # @return [String]
+    attr_accessor :package
+
+    # Indicates whether the dependency is direct or transitive
+    # @return [Transitivity2]
+    attr_accessor :transitivity
+
+    # Version of the package that was found to be vulnerable
+    # @return [String]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ecosystem'] = 'ecosystem'
+      @_hash['lockfile_line_url'] = 'lockfile_line_url'
+      @_hash['package'] = 'package'
+      @_hash['transitivity'] = 'transitivity'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ecosystem
+        lockfile_line_url
+        package
+        transitivity
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ecosystem: Ecosystem2::NO_PACKAGE_MANAGER,
+                   lockfile_line_url: SKIP, package: SKIP, transitivity: SKIP,
+                   version: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ecosystem = ecosystem unless ecosystem == SKIP
+      @lockfile_line_url = lockfile_line_url unless lockfile_line_url == SKIP
+      @package = package unless package == SKIP
+      @transitivity = transitivity unless transitivity == SKIP
+      @version = version unless version == 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.
+      ecosystem = hash['ecosystem'] ||= Ecosystem2::NO_PACKAGE_MANAGER
+      lockfile_line_url =
+        hash.key?('lockfile_line_url') ? hash['lockfile_line_url'] : SKIP
+      package = hash.key?('package') ? hash['package'] : SKIP
+      transitivity = hash.key?('transitivity') ? hash['transitivity'] : SKIP
+      version = hash.key?('version') ? hash['version'] : 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.
+      FoundDependency.new(ecosystem: ecosystem,
+                          lockfile_line_url: lockfile_line_url,
+                          package: package,
+                          transitivity: transitivity,
+                          version: version,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FoundDependency | 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} ecosystem: #{@ecosystem}, lockfile_line_url: #{@lockfile_line_url},"\
+      " package: #{@package}, transitivity: #{@transitivity}, version: #{@version},"\
+      " 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} ecosystem: #{@ecosystem.inspect}, lockfile_line_url:"\
+      " #{@lockfile_line_url.inspect}, package: #{@package.inspect}, transitivity:"\
+      " #{@transitivity.inspect}, version: #{@version.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/get_project_response.rb

@@ -0,0 +1,73 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Successfully retrieved details for the project.
+  class GetProjectResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A project in your organization that uses Semgrep.
+    # @return [Project]
+    attr_accessor :project
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['project'] = 'project'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(project:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @project = project
+      @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.
+      project = Project.from_hash(hash['project']) if hash['project']
+
+      # 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.
+      GetProjectResponse.new(project: project,
+                             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} project: #{@project}, 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} project: #{@project.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/get_sbom_export_response.rb

@@ -0,0 +1,100 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # GetSbomExportResponse Model.
+  class GetSbomExportResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL to download the SBOM when status is COMPLETED.
+    # @return [String]
+    attr_accessor :download_url
+
+    # Error message when status is FAILED.
+    # @return [String]
+    attr_accessor :error_message
+
+    # Status of the SBOM export job.
+    # | value | description |
+    # |-------|---------------|
+    # | SBOM_EXPORT_STATUS_IN_PROGRESS | The SBOM export job is in progress. |
+    # | SBOM_EXPORT_STATUS_COMPLETED | The SBOM export job has completed. |
+    # | SBOM_EXPORT_STATUS_FAILED | The SBOM export job has failed. |
+    # @return [Status3]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['download_url'] = 'downloadUrl'
+      @_hash['error_message'] = 'errorMessage'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        download_url
+        error_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status:, download_url: SKIP, error_message: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @download_url = download_url unless download_url == SKIP
+      @error_message = error_message unless error_message == SKIP
+      @status = status
+      @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.
+      status = hash.key?('status') ? hash['status'] : nil
+      download_url = hash.key?('downloadUrl') ? hash['downloadUrl'] : SKIP
+      error_message = hash.key?('errorMessage') ? hash['errorMessage'] : 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.
+      GetSbomExportResponse.new(status: status,
+                                download_url: download_url,
+                                error_message: error_message,
+                                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} download_url: #{@download_url}, error_message: #{@error_message}, status:"\
+      " #{@status}, 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} download_url: #{@download_url.inspect}, error_message:"\
+      " #{@error_message.inspect}, status: #{@status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/guidance.rb

@@ -0,0 +1,98 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Remediation guidance generated by Semgrep Assistant
+  class Guidance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Step-by-step instructions explaining to a developer how to fix the
+    # finding. AI generated content, review carefully
+    # @return [String]
+    attr_accessor :instructions
+
+    # Short title explaining to a developer how to fix the finding. AI generated
+    # content, review carefully
+    # @return [String]
+    attr_accessor :summary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['instructions'] = 'instructions'
+      @_hash['summary'] = 'summary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        instructions
+        summary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(instructions: SKIP, summary: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @instructions = instructions unless instructions == SKIP
+      @summary = summary unless summary == 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.
+      instructions = hash.key?('instructions') ? hash['instructions'] : SKIP
+      summary = hash.key?('summary') ? hash['summary'] : 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.
+      Guidance.new(instructions: instructions,
+                   summary: summary,
+                   additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Guidance | 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} instructions: #{@instructions}, summary: #{@summary},"\
+      " 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} instructions: #{@instructions.inspect}, summary: #{@summary.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/issue_type.rb

@@ -0,0 +1,40 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Type of findings to bulk triage.
+  class IssueType
+    ISSUE_TYPE = [
+      # TODO: Write general description for SAST
+      SAST = 'sast'.freeze,
+
+      # TODO: Write general description for SCA
+      SCA = 'sca'.freeze,
+
+      # TODO: Write general description for SECRETS
+      SECRETS = 'secrets'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ISSUE_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = SAST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sast' then SAST
+      when 'sca' then SCA
+      when 'secrets' then SECRETS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/issue_type1.rb

@@ -0,0 +1,40 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Type of findings to create tickets for.
+  class IssueType1
+    ISSUE_TYPE1 = [
+      # TODO: Write general description for SAST
+      SAST = 'sast'.freeze,
+
+      # TODO: Write general description for SCA
+      SCA = 'sca'.freeze,
+
+      # TODO: Write general description for SECRETS
+      SECRETS = 'secrets'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ISSUE_TYPE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = SAST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sast' then SAST
+      when 'sca' then SCA
+      when 'secrets' then SECRETS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/issue_type2.rb

@@ -0,0 +1,42 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Type of findings to return. If not specified, returns `sast` (Code)
+  # findings. Can be `sast` (Code), `sca` (Supply Chain), or `ai_sast`
+  # (AI-powered scan). Valid values: sast, sca, ai_sast
+  class IssueType2
+    ISSUE_TYPE2 = [
+      # TODO: Write general description for SAST
+      SAST = 'sast'.freeze,
+
+      # TODO: Write general description for SCA
+      SCA = 'sca'.freeze,
+
+      # TODO: Write general description for AI_SAST
+      AI_SAST = 'ai_sast'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ISSUE_TYPE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = SAST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sast' then SAST
+      when 'sca' then SCA
+      when 'ai_sast' then AI_SAST
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/license_policy_settings.rb

@@ -0,0 +1,42 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Filter by license policy setting outcome. | value | description |
+  # |-------|---------------| | LICENSE_POLICY_SETTING_ALLOW |  | |
+  # LICENSE_POLICY_SETTING_COMMENT |  | | LICENSE_POLICY_SETTING_BLOCK |  |
+  class LicensePolicySettings
+    LICENSE_POLICY_SETTINGS = [
+      # TODO: Write general description for LICENSE_POLICY_SETTING_ALLOW
+      LICENSE_POLICY_SETTING_ALLOW = 'LICENSE_POLICY_SETTING_ALLOW'.freeze,
+
+      # TODO: Write general description for LICENSE_POLICY_SETTING_COMMENT
+      LICENSE_POLICY_SETTING_COMMENT = 'LICENSE_POLICY_SETTING_COMMENT'.freeze,
+
+      # TODO: Write general description for LICENSE_POLICY_SETTING_BLOCK
+      LICENSE_POLICY_SETTING_BLOCK = 'LICENSE_POLICY_SETTING_BLOCK'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LICENSE_POLICY_SETTINGS.include?(value)
+    end
+
+    def self.from_value(value, default_value = LICENSE_POLICY_SETTING_ALLOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'license_policy_setting_allow' then LICENSE_POLICY_SETTING_ALLOW
+      when 'license_policy_setting_comment' then LICENSE_POLICY_SETTING_COMMENT
+      when 'license_policy_setting_block' then LICENSE_POLICY_SETTING_BLOCK
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/link_ticket_request.rb

@@ -0,0 +1,93 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Link ticket request
+  class LinkTicketRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Deployment ID. Can be found at /deployments, or in your Settings in the
+    # web UI.
+    # @return [String]
+    attr_accessor :deployment_id
+
+    # An array of Semgrep finding IDs to link the ticket to.
+    # @return [Array[String]]
+    attr_accessor :issue_ids
+
+    # The URL of the external ticket to link (e.g.
+    # https://myorg.atlassian.net/browse/SEC-123).
+    # @return [String]
+    attr_accessor :ticket_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['deployment_id'] = 'deploymentId'
+      @_hash['issue_ids'] = 'issue_ids'
+      @_hash['ticket_url'] = 'ticket_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(deployment_id:, issue_ids:, ticket_url:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deployment_id = deployment_id
+      @issue_ids = issue_ids
+      @ticket_url = ticket_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.
+      deployment_id = hash.key?('deploymentId') ? hash['deploymentId'] : nil
+      issue_ids = hash.key?('issue_ids') ? hash['issue_ids'] : nil
+      ticket_url = hash.key?('ticket_url') ? hash['ticket_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.
+      LinkTicketRequest.new(deployment_id: deployment_id,
+                            issue_ids: issue_ids,
+                            ticket_url: ticket_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} deployment_id: #{@deployment_id}, issue_ids: #{@issue_ids}, ticket_url:"\
+      " #{@ticket_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} deployment_id: #{@deployment_id.inspect}, issue_ids: #{@issue_ids.inspect},"\
+      " ticket_url: #{@ticket_url.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end