apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/assistant.rb

@@ -0,0 +1,127 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Semgrep Assistant data. Only present if Assistant is enabled
+  class Assistant < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Fix data generated by Semgrep Assistant
+    # @return [Autofix]
+    attr_accessor :autofix
+
+    # Triage recommendation generated by Semgrep Assistant
+    # @return [Autotriage]
+    attr_accessor :autotriage
+
+    # Semgrep Assistant's guess as for what the matched source code's purpose is
+    # @return [Component]
+    attr_accessor :component
+
+    # Remediation guidance generated by Semgrep Assistant
+    # @return [Guidance]
+    attr_accessor :guidance
+
+    # AI-generated explanation of why a rule flagged this specific code
+    # @return [RuleExplanation]
+    attr_accessor :rule_explanation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['autofix'] = 'autofix'
+      @_hash['autotriage'] = 'autotriage'
+      @_hash['component'] = 'component'
+      @_hash['guidance'] = 'guidance'
+      @_hash['rule_explanation'] = 'rule_explanation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        autofix
+        autotriage
+        component
+        guidance
+        rule_explanation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(autofix: SKIP, autotriage: SKIP, component: SKIP,
+                   guidance: SKIP, rule_explanation: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @autofix = autofix unless autofix == SKIP
+      @autotriage = autotriage unless autotriage == SKIP
+      @component = component unless component == SKIP
+      @guidance = guidance unless guidance == SKIP
+      @rule_explanation = rule_explanation unless rule_explanation == 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.
+      autofix = Autofix.from_hash(hash['autofix']) if hash['autofix']
+      autotriage = Autotriage.from_hash(hash['autotriage']) if hash['autotriage']
+      component = Component.from_hash(hash['component']) if hash['component']
+      guidance = Guidance.from_hash(hash['guidance']) if hash['guidance']
+      rule_explanation = RuleExplanation.from_hash(hash['rule_explanation']) if
+        hash['rule_explanation']
+
+      # 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.
+      Assistant.new(autofix: autofix,
+                    autotriage: autotriage,
+                    component: component,
+                    guidance: guidance,
+                    rule_explanation: rule_explanation,
+                    additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Assistant | 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} autofix: #{@autofix}, autotriage: #{@autotriage}, component: #{@component},"\
+      " guidance: #{@guidance}, rule_explanation: #{@rule_explanation}, 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} autofix: #{@autofix.inspect}, autotriage: #{@autotriage.inspect},"\
+      " component: #{@component.inspect}, guidance: #{@guidance.inspect}, rule_explanation:"\
+      " #{@rule_explanation.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/autofix.rb

@@ -0,0 +1,98 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Fix data generated by Semgrep Assistant
+  class Autofix < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # DEPRECATED: This field is deprecated and will always be an empty string.
+    # Find a description of how this fix works under `assistant.guidance`
+    # @return [String]
+    attr_accessor :explanation
+
+    # Source code that replaces all matched lines to fix this finding. AI
+    # generated content, review carefully
+    # @return [String]
+    attr_accessor :fix_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['explanation'] = 'explanation'
+      @_hash['fix_code'] = 'fix_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        explanation
+        fix_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(explanation: SKIP, fix_code: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @explanation = explanation unless explanation == SKIP
+      @fix_code = fix_code unless fix_code == 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.
+      explanation = hash.key?('explanation') ? hash['explanation'] : SKIP
+      fix_code = hash.key?('fix_code') ? hash['fix_code'] : 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.
+      Autofix.new(explanation: explanation,
+                  fix_code: fix_code,
+                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Autofix | 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} explanation: #{@explanation}, fix_code: #{@fix_code},"\
+      " 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} explanation: #{@explanation.inspect}, fix_code: #{@fix_code.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/autotriage.rb

@@ -0,0 +1,98 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Triage recommendation generated by Semgrep Assistant
+  class Autotriage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reasoning for a `false_positive` verdict; this explains why you might
+    # want to ignore the finding. Empty string if verdict is `true_positive`
+    # @return [String]
+    attr_accessor :reason
+
+    # The verdict is `true_positive` if Assistant recommends fixing,
+    # `false_positive` if Assistant recommends ignoring this finding. AI
+    # generated decision, review carefully
+    # @return [Verdict1]
+    attr_accessor :verdict
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash['verdict'] = 'verdict'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+        verdict
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason: SKIP, verdict: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reason = reason unless reason == SKIP
+      @verdict = verdict unless verdict == 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.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      verdict = hash.key?('verdict') ? hash['verdict'] : 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.
+      Autotriage.new(reason: reason,
+                     verdict: verdict,
+                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Autotriage | 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} reason: #{@reason}, verdict: #{@verdict}, 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} reason: #{@reason.inspect}, verdict: #{@verdict.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/autotriage_verdict.rb

@@ -0,0 +1,36 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # The autotriage verdict to filter by
+  class AutotriageVerdict
+    AUTOTRIAGE_VERDICT = [
+      # TODO: Write general description for TRUE_POSITIVE
+      TRUE_POSITIVE = 'true_positive'.freeze,
+
+      # TODO: Write general description for FALSE_POSITIVE
+      FALSE_POSITIVE = 'false_positive'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AUTOTRIAGE_VERDICT.include?(value)
+    end
+
+    def self.from_value(value, default_value = TRUE_POSITIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'true_positive' then TRUE_POSITIVE
+      when 'false_positive' then FALSE_POSITIVE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/autotriage_verdict2.rb

@@ -0,0 +1,38 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Which autotriage verdict do you want to include? If not specified, includes
+  # all. This filter is applicable when `issue_type` is `sast` or unspecified.
+  # Valid values: true_positive, false_positive
+  class AutotriageVerdict2
+    AUTOTRIAGE_VERDICT2 = [
+      # TODO: Write general description for TRUE_POSITIVE
+      TRUE_POSITIVE = 'true_positive'.freeze,
+
+      # TODO: Write general description for FALSE_POSITIVE
+      FALSE_POSITIVE = 'false_positive'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AUTOTRIAGE_VERDICT2.include?(value)
+    end
+
+    def self.from_value(value, default_value = TRUE_POSITIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'true_positive' then TRUE_POSITIVE
+      when 'false_positive' then FALSE_POSITIVE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/base_model.rb

@@ -0,0 +1,110 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end