apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/list_dependencies_request.rb

@@ -0,0 +1,108 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # ListDependenciesRequest Model.
+  class ListDependenciesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Cursor to paginate through the dependencies. Provide a cursor value from
+    # the response to retrieve the next page.
+    # @return [String]
+    attr_accessor :cursor
+
+    # Object to provide dependency details to filter by.
+    # @return [ProtosScaV1DependencyFilter]
+    attr_accessor :dependency_filter
+
+    # Deployment ID (numeric). Example: `123`. Can be found at `/deployments`,
+    # or in your Settings in the web UI.
+    # @return [String]
+    attr_accessor :deployment_id
+
+    # Number of dependencies per page. Default: 1000, min: 1, max: 10000.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cursor'] = 'cursor'
+      @_hash['dependency_filter'] = 'dependencyFilter'
+      @_hash['deployment_id'] = 'deploymentId'
+      @_hash['page_size'] = 'pageSize'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cursor
+        dependency_filter
+        page_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(deployment_id:, cursor: SKIP, dependency_filter: SKIP,
+                   page_size: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cursor = cursor unless cursor == SKIP
+      @dependency_filter = dependency_filter unless dependency_filter == SKIP
+      @deployment_id = deployment_id
+      @page_size = page_size unless page_size == 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
+      cursor = hash.key?('cursor') ? hash['cursor'] : SKIP
+      dependency_filter = ProtosScaV1DependencyFilter.from_hash(hash['dependencyFilter']) if
+        hash['dependencyFilter']
+      page_size = hash.key?('pageSize') ? hash['pageSize'] : 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.
+      ListDependenciesRequest.new(deployment_id: deployment_id,
+                                  cursor: cursor,
+                                  dependency_filter: dependency_filter,
+                                  page_size: page_size,
+                                  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} cursor: #{@cursor}, dependency_filter: #{@dependency_filter},"\
+      " deployment_id: #{@deployment_id}, page_size: #{@page_size}, 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} cursor: #{@cursor.inspect}, dependency_filter:"\
+      " #{@dependency_filter.inspect}, deployment_id: #{@deployment_id.inspect}, page_size:"\
+      " #{@page_size.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/list_dependencies_response.rb

@@ -0,0 +1,102 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # ListDependenciesResponse Model.
+  class ListDependenciesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Pass to next request to get next page of results.
+    # @return [String]
+    attr_accessor :cursor
+
+    # List of dependencies.
+    # @return [Array[ProtosScaV1FoundDependency]]
+    attr_accessor :dependencies
+
+    # True if there are more dependencies to get.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cursor'] = 'cursor'
+      @_hash['dependencies'] = 'dependencies'
+      @_hash['has_more'] = 'hasMore'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cursor
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(dependencies:, has_more:, cursor: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cursor = cursor unless cursor == SKIP
+      @dependencies = dependencies
+      @has_more = has_more
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      dependencies = nil
+      unless hash['dependencies'].nil?
+        dependencies = []
+        hash['dependencies'].each do |structure|
+          dependencies << (ProtosScaV1FoundDependency.from_hash(structure) if structure)
+        end
+      end
+
+      dependencies = nil unless hash.key?('dependencies')
+      has_more = hash.key?('hasMore') ? hash['hasMore'] : nil
+      cursor = hash.key?('cursor') ? hash['cursor'] : 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.
+      ListDependenciesResponse.new(dependencies: dependencies,
+                                   has_more: has_more,
+                                   cursor: cursor,
+                                   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} cursor: #{@cursor}, dependencies: #{@dependencies}, has_more: #{@has_more},"\
+      " 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} cursor: #{@cursor.inspect}, dependencies: #{@dependencies.inspect},"\
+      " has_more: #{@has_more.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/list_findings_response.rb

@@ -0,0 +1,100 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Response containing a paginated list of findings (either Code or Supply
+  # Chain findings) with optional filtering applied
+  class ListFindingsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of AI-powered scan findings that Semgrep has identified in your
+    # organization
+    # @return [AiSastFindings]
+    attr_accessor :ai_sast_findings
+
+    # A list of Code findings that Semgrep has identified in your organization
+    # @return [SastFindings]
+    attr_accessor :sast_findings
+
+    # A list of Supply Chain findings that Semgrep has identified in your
+    # organization
+    # @return [ScaFindings]
+    attr_accessor :sca_findings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ai_sast_findings'] = 'aiSastFindings'
+      @_hash['sast_findings'] = 'sastFindings'
+      @_hash['sca_findings'] = 'scaFindings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ai_sast_findings
+        sast_findings
+        sca_findings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ai_sast_findings: SKIP, sast_findings: SKIP,
+                   sca_findings: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ai_sast_findings = ai_sast_findings unless ai_sast_findings == SKIP
+      @sast_findings = sast_findings unless sast_findings == SKIP
+      @sca_findings = sca_findings unless sca_findings == 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.
+      ai_sast_findings = AiSastFindings.from_hash(hash['aiSastFindings']) if
+        hash['aiSastFindings']
+      sast_findings = SastFindings.from_hash(hash['sastFindings']) if hash['sastFindings']
+      sca_findings = ScaFindings.from_hash(hash['scaFindings']) if hash['scaFindings']
+
+      # 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.
+      ListFindingsResponse.new(ai_sast_findings: ai_sast_findings,
+                               sast_findings: sast_findings,
+                               sca_findings: sca_findings,
+                               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} ai_sast_findings: #{@ai_sast_findings}, sast_findings: #{@sast_findings},"\
+      " sca_findings: #{@sca_findings}, 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} ai_sast_findings: #{@ai_sast_findings.inspect}, sast_findings:"\
+      " #{@sast_findings.inspect}, sca_findings: #{@sca_findings.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/list_lockfiles_for_dependencies_request.rb

@@ -0,0 +1,118 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # ListLockfilesForDependenciesRequest Model.
+  class ListLockfilesForDependenciesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Use cursor in response to get next page of results.
+    # @return [String]
+    attr_accessor :cursor
+
+    # Object to provide dependency details to filter by.
+    # @return [ProtosScaV1DependencyFilter]
+    attr_accessor :dependency_filter
+
+    # Deployment ID (numeric). Example: `123`. Can be found at `/deployments`,
+    # or in your Settings in the web UI.
+    # @return [String]
+    attr_accessor :deployment_id
+
+    # Number of repositories per page. Default: 5, min: 1, max: 100.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # Repository ID to filter by. Use Projects endpoints to retrieve repository
+    # IDs.
+    # @return [String]
+    attr_accessor :repository_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cursor'] = 'cursor'
+      @_hash['dependency_filter'] = 'dependencyFilter'
+      @_hash['deployment_id'] = 'deploymentId'
+      @_hash['page_size'] = 'pageSize'
+      @_hash['repository_id'] = 'repositoryId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cursor
+        dependency_filter
+        page_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(deployment_id:, repository_id:, cursor: SKIP,
+                   dependency_filter: SKIP, page_size: 5,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cursor = cursor unless cursor == SKIP
+      @dependency_filter = dependency_filter unless dependency_filter == SKIP
+      @deployment_id = deployment_id
+      @page_size = page_size unless page_size == SKIP
+      @repository_id = repository_id
+      @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
+      repository_id = hash.key?('repositoryId') ? hash['repositoryId'] : nil
+      cursor = hash.key?('cursor') ? hash['cursor'] : SKIP
+      dependency_filter = ProtosScaV1DependencyFilter.from_hash(hash['dependencyFilter']) if
+        hash['dependencyFilter']
+      page_size = hash['pageSize'] ||= 5
+
+      # 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.
+      ListLockfilesForDependenciesRequest.new(deployment_id: deployment_id,
+                                              repository_id: repository_id,
+                                              cursor: cursor,
+                                              dependency_filter: dependency_filter,
+                                              page_size: page_size,
+                                              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} cursor: #{@cursor}, dependency_filter: #{@dependency_filter},"\
+      " deployment_id: #{@deployment_id}, page_size: #{@page_size}, repository_id:"\
+      " #{@repository_id}, 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} cursor: #{@cursor.inspect}, dependency_filter:"\
+      " #{@dependency_filter.inspect}, deployment_id: #{@deployment_id.inspect}, page_size:"\
+      " #{@page_size.inspect}, repository_id: #{@repository_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/list_lockfiles_for_dependencies_response.rb

@@ -0,0 +1,103 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # ListLockfilesForDependenciesResponse Model.
+  class ListLockfilesForDependenciesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Pass to next request to get next page of results.
+    # @return [String]
+    attr_accessor :cursor
+
+    # True if there are more lockfiles to get.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more
+
+    # List of lockfiles.
+    # @return [Array[ProtosScaV1LockfileDependencySummary]]
+    attr_accessor :lockfile_summaries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cursor'] = 'cursor'
+      @_hash['has_more'] = 'hasMore'
+      @_hash['lockfile_summaries'] = 'lockfileSummaries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cursor
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(has_more:, lockfile_summaries:, cursor: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cursor = cursor unless cursor == SKIP
+      @has_more = has_more
+      @lockfile_summaries = lockfile_summaries
+      @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.
+      has_more = hash.key?('hasMore') ? hash['hasMore'] : nil
+      # Parameter is an array, so we need to iterate through it
+      lockfile_summaries = nil
+      unless hash['lockfileSummaries'].nil?
+        lockfile_summaries = []
+        hash['lockfileSummaries'].each do |structure|
+          lockfile_summaries << (ProtosScaV1LockfileDependencySummary.from_hash(structure) if structure)
+        end
+      end
+
+      lockfile_summaries = nil unless hash.key?('lockfileSummaries')
+      cursor = hash.key?('cursor') ? hash['cursor'] : 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.
+      ListLockfilesForDependenciesResponse.new(has_more: has_more,
+                                               lockfile_summaries: lockfile_summaries,
+                                               cursor: cursor,
+                                               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} cursor: #{@cursor}, has_more: #{@has_more}, lockfile_summaries:"\
+      " #{@lockfile_summaries}, 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} cursor: #{@cursor.inspect}, has_more: #{@has_more.inspect},"\
+      " lockfile_summaries: #{@lockfile_summaries.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/list_project.rb

@@ -0,0 +1,145 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # A project in your organization that uses Semgrep.
+  class ListProject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Time when this project was created.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The default branch in the SCM.
+    # @return [String]
+    attr_accessor :default_branch
+
+    # Unique ID of this project.
+    # @return [Integer]
+    attr_accessor :id
+
+    # Time of latest scan, if there is one.
+    # @return [String]
+    attr_accessor :latest_scan_at
+
+    # Name of the project.
+    # @return [String]
+    attr_accessor :name
+
+    # The primary branch of the project, if known.
+    # @return [String]
+    attr_accessor :primary_branch
+
+    # Tags associated to this project.
+    # @return [Array[String]]
+    attr_accessor :tags
+
+    # URL of the project, if there is one.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['default_branch'] = 'default_branch'
+      @_hash['id'] = 'id'
+      @_hash['latest_scan_at'] = 'latest_scan_at'
+      @_hash['name'] = 'name'
+      @_hash['primary_branch'] = 'primary_branch'
+      @_hash['tags'] = 'tags'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_at
+        default_branch
+        latest_scan_at
+        primary_branch
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, name:, tags:, created_at: SKIP, default_branch: SKIP,
+                   latest_scan_at: SKIP, primary_branch: SKIP, url: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @created_at = created_at unless created_at == SKIP
+      @default_branch = default_branch unless default_branch == SKIP
+      @id = id
+      @latest_scan_at = latest_scan_at unless latest_scan_at == SKIP
+      @name = name
+      @primary_branch = primary_branch unless primary_branch == SKIP
+      @tags = tags
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      tags = hash.key?('tags') ? hash['tags'] : nil
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      default_branch =
+        hash.key?('default_branch') ? hash['default_branch'] : SKIP
+      latest_scan_at =
+        hash.key?('latest_scan_at') ? hash['latest_scan_at'] : SKIP
+      primary_branch =
+        hash.key?('primary_branch') ? hash['primary_branch'] : 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.
+      ListProject.new(id: id,
+                      name: name,
+                      tags: tags,
+                      created_at: created_at,
+                      default_branch: default_branch,
+                      latest_scan_at: latest_scan_at,
+                      primary_branch: primary_branch,
+                      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} created_at: #{@created_at}, default_branch: #{@default_branch}, id: #{@id},"\
+      " latest_scan_at: #{@latest_scan_at}, name: #{@name}, primary_branch: #{@primary_branch},"\
+      " tags: #{@tags}, 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} created_at: #{@created_at.inspect}, default_branch:"\
+      " #{@default_branch.inspect}, id: #{@id.inspect}, latest_scan_at:"\
+      " #{@latest_scan_at.inspect}, name: #{@name.inspect}, primary_branch:"\
+      " #{@primary_branch.inspect}, tags: #{@tags.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end