apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/transitivity2.rb

@@ -0,0 +1,40 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Indicates whether the dependency is direct or transitive
+  class Transitivity2
+    TRANSITIVITY2 = [
+      # TODO: Write general description for DIRECT
+      DIRECT = 'direct'.freeze,
+
+      # TODO: Write general description for TRANSITIVE
+      TRANSITIVE = 'transitive'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRANSITIVITY2.include?(value)
+    end
+
+    def self.from_value(value, default_value = DIRECT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'direct' then DIRECT
+      when 'transitive' then TRANSITIVE
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/triage_reason.rb

@@ -0,0 +1,48 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Reason provided when this issue was triaged
+  class TriageReason
+    TRIAGE_REASON = [
+      # TODO: Write general description for ACCEPTABLE_RISK
+      ACCEPTABLE_RISK = 'acceptable_risk'.freeze,
+
+      # TODO: Write general description for FALSE_POSITIVE
+      FALSE_POSITIVE = 'false_positive'.freeze,
+
+      # TODO: Write general description for NO_TIME
+      NO_TIME = 'no_time'.freeze,
+
+      # TODO: Write general description for NO_TRIAGE_REASON
+      NO_TRIAGE_REASON = 'no_triage_reason'.freeze,
+
+      # TODO: Write general description for DUPLICATE
+      DUPLICATE = 'duplicate'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRIAGE_REASON.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCEPTABLE_RISK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'acceptable_risk' then ACCEPTABLE_RISK
+      when 'false_positive' then FALSE_POSITIVE
+      when 'no_time' then NO_TIME
+      when 'no_triage_reason' then NO_TRIAGE_REASON
+      when 'duplicate' then DUPLICATE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/triage_reasons.rb

@@ -0,0 +1,48 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # List of triage reasons to filter by
+  class TriageReasons
+    TRIAGE_REASONS = [
+      # TODO: Write general description for ACCEPTABLE_RISK
+      ACCEPTABLE_RISK = 'acceptable_risk'.freeze,
+
+      # TODO: Write general description for FALSE_POSITIVE
+      FALSE_POSITIVE = 'false_positive'.freeze,
+
+      # TODO: Write general description for NO_TIME
+      NO_TIME = 'no_time'.freeze,
+
+      # TODO: Write general description for NO_TRIAGE_REASON
+      NO_TRIAGE_REASON = 'no_triage_reason'.freeze,
+
+      # TODO: Write general description for DUPLICATE
+      DUPLICATE = 'duplicate'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRIAGE_REASONS.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCEPTABLE_RISK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'acceptable_risk' then ACCEPTABLE_RISK
+      when 'false_positive' then FALSE_POSITIVE
+      when 'no_time' then NO_TIME
+      when 'no_triage_reason' then NO_TRIAGE_REASON
+      when 'duplicate' then DUPLICATE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/triage_reasons2.rb

@@ -0,0 +1,50 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Which triage reasons do you want to include? If not specified, includes all.
+  # This filter is applicable when `status` is `ignored`. Valid values:
+  # acceptable_risk, false_positive, no_time, no_triage_reason, duplicate
+  class TriageReasons2
+    TRIAGE_REASONS2 = [
+      # TODO: Write general description for ACCEPTABLE_RISK
+      ACCEPTABLE_RISK = 'acceptable_risk'.freeze,
+
+      # TODO: Write general description for FALSE_POSITIVE
+      FALSE_POSITIVE = 'false_positive'.freeze,
+
+      # TODO: Write general description for NO_TIME
+      NO_TIME = 'no_time'.freeze,
+
+      # TODO: Write general description for NO_TRIAGE_REASON
+      NO_TRIAGE_REASON = 'no_triage_reason'.freeze,
+
+      # TODO: Write general description for DUPLICATE
+      DUPLICATE = 'duplicate'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRIAGE_REASONS2.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCEPTABLE_RISK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'acceptable_risk' then ACCEPTABLE_RISK
+      when 'false_positive' then FALSE_POSITIVE
+      when 'no_time' then NO_TIME
+      when 'no_triage_reason' then NO_TRIAGE_REASON
+      when 'duplicate' then DUPLICATE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/triage_state.rb

@@ -0,0 +1,54 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # The finding's triage state. Note: "reviewing" and "fixing" are only in
+  # private beta. Set by the user and used along with state to generate the
+  # final "status" viewable in the UI
+  class TriageState
+    TRIAGE_STATE = [
+      # TODO: Write general description for UNTRIAGED
+      UNTRIAGED = 'untriaged'.freeze,
+
+      # TODO: Write general description for IGNORED
+      IGNORED = 'ignored'.freeze,
+
+      # TODO: Write general description for REOPENED
+      REOPENED = 'reopened'.freeze,
+
+      # TODO: Write general description for REVIEWING
+      REVIEWING = 'reviewing'.freeze,
+
+      # TODO: Write general description for FIXING
+      FIXING = 'fixing'.freeze,
+
+      # TODO: Write general description for PROVISIONALLY_IGNORED
+      PROVISIONALLY_IGNORED = 'provisionally_ignored'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRIAGE_STATE.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNTRIAGED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'untriaged' then UNTRIAGED
+      when 'ignored' then IGNORED
+      when 'reopened' then REOPENED
+      when 'reviewing' then REVIEWING
+      when 'fixing' then FIXING
+      when 'provisionally_ignored' then PROVISIONALLY_IGNORED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/unlink_ticket_request.rb

@@ -0,0 +1,83 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Unlink ticket request
+  class UnlinkTicketRequest < 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 unlink tickets from.
+    # @return [Array[String]]
+    attr_accessor :issue_ids
+
+    # 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
+    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:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deployment_id = deployment_id
+      @issue_ids = issue_ids
+      @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
+
+      # 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.
+      UnlinkTicketRequest.new(deployment_id: deployment_id,
+                              issue_ids: issue_ids,
+                              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},"\
+      " 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},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/update_policy_request.rb

@@ -0,0 +1,113 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # UpdatePolicyRequest Model.
+  class UpdatePolicyRequest < 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
+
+    # Policy ID (numeric). Example: `456`. Can be found at
+    # `/deployments/{deploymentId}/policies`.
+    # @return [String]
+    attr_accessor :policy_id
+
+    # New policy mode to set for the Rule.
+    #  - MODE_MONITOR: Monitor mode, silently report findings
+    #  - MODE_COMMENT: Comment mode, leaves PR comments but does not block
+    #  - MODE_BLOCK: Block mode, leaves PR comments and blocks PR
+    #  - MODE_DISABLED: Disabled mode, not active
+    # | value | description |
+    # |-------|---------------|
+    # | MODE_MONITOR | Monitor mode, silently report findings |
+    # | MODE_COMMENT | Comment mode, leaves PR comments but does not block |
+    # | MODE_BLOCK | Block mode, leaves PR comments and blocks PR |
+    # | MODE_DISABLED | Disabled mode, not active |
+    # @return [PolicyMode3]
+    attr_accessor :policy_mode
+
+    # Full path of the Rule.
+    # @return [String]
+    attr_accessor :rule_path
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['deployment_id'] = 'deploymentId'
+      @_hash['policy_id'] = 'policyId'
+      @_hash['policy_mode'] = 'policyMode'
+      @_hash['rule_path'] = 'rulePath'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(deployment_id:, policy_id:, policy_mode:, rule_path:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deployment_id = deployment_id
+      @policy_id = policy_id
+      @policy_mode = policy_mode
+      @rule_path = rule_path
+      @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
+      policy_id = hash.key?('policyId') ? hash['policyId'] : nil
+      policy_mode = hash.key?('policyMode') ? hash['policyMode'] : nil
+      rule_path = hash.key?('rulePath') ? hash['rulePath'] : 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.
+      UpdatePolicyRequest.new(deployment_id: deployment_id,
+                              policy_id: policy_id,
+                              policy_mode: policy_mode,
+                              rule_path: rule_path,
+                              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}, policy_id: #{@policy_id}, policy_mode:"\
+      " #{@policy_mode}, rule_path: #{@rule_path}, 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}, policy_id: #{@policy_id.inspect},"\
+      " policy_mode: #{@policy_mode.inspect}, rule_path: #{@rule_path.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/update_project_request.rb

@@ -0,0 +1,121 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # UpdateProjectRequest Model.
+  class UpdateProjectRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Slug of the deployment name. Can be found at `/deployments`, or in your
+    # Settings in the web UI.
+    # @return [String]
+    attr_accessor :deployment_slug
+
+    # [Beta] Configuration of Semgrep Managed Scans for the project, if
+    # relevant.
+    # @return [ManagedScanConfig]
+    attr_accessor :managed_scan_config
+
+    # The full name of the branch you would like to set as primary. Use "None"
+    # if default_branch is known and you wish to set primary to always be the
+    # default branch.
+    # @return [String]
+    attr_accessor :primary_branch
+
+    # Name of the project, typically the repository formatted as a path.
+    # @return [String]
+    attr_accessor :project_name
+
+    # Tags associated to this project.
+    # @return [Array[String]]
+    attr_accessor :tags
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['deployment_slug'] = 'deploymentSlug'
+      @_hash['managed_scan_config'] = 'managed_scan_config'
+      @_hash['primary_branch'] = 'primary_branch'
+      @_hash['project_name'] = 'projectName'
+      @_hash['tags'] = 'tags'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        managed_scan_config
+        primary_branch
+        tags
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(deployment_slug:, project_name:, managed_scan_config: SKIP,
+                   primary_branch: SKIP, tags: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deployment_slug = deployment_slug
+      @managed_scan_config = managed_scan_config unless managed_scan_config == SKIP
+      @primary_branch = primary_branch unless primary_branch == SKIP
+      @project_name = project_name
+      @tags = tags unless tags == 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_slug =
+        hash.key?('deploymentSlug') ? hash['deploymentSlug'] : nil
+      project_name = hash.key?('projectName') ? hash['projectName'] : nil
+      managed_scan_config = ManagedScanConfig.from_hash(hash['managed_scan_config']) if
+        hash['managed_scan_config']
+      primary_branch =
+        hash.key?('primary_branch') ? hash['primary_branch'] : SKIP
+      tags = hash.key?('tags') ? hash['tags'] : 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.
+      UpdateProjectRequest.new(deployment_slug: deployment_slug,
+                               project_name: project_name,
+                               managed_scan_config: managed_scan_config,
+                               primary_branch: primary_branch,
+                               tags: tags,
+                               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_slug: #{@deployment_slug}, managed_scan_config:"\
+      " #{@managed_scan_config}, primary_branch: #{@primary_branch}, project_name:"\
+      " #{@project_name}, tags: #{@tags}, 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_slug: #{@deployment_slug.inspect}, managed_scan_config:"\
+      " #{@managed_scan_config.inspect}, primary_branch: #{@primary_branch.inspect}, project_name:"\
+      " #{@project_name.inspect}, tags: #{@tags.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/update_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 updated details for the project.
+  class UpdateProjectResponse < 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.
+      UpdateProjectResponse.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