apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/policy.rb

@@ -0,0 +1,118 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Policy Model.
+  class Policy < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the Policy.
+    # @return [String]
+    attr_accessor :id
+
+    # When True, the Policy applies to all repositories.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_default
+
+    # Name of the Policy.
+    # @return [String]
+    attr_accessor :name
+
+    # Product type the Policy applies to.
+    # | value | description |
+    # |-------|---------------|
+    # | PRODUCT_TYPE_SAST | The product type for Code rules. |
+    # | PRODUCT_TYPE_SECRETS | The product type for Secrets rules. |
+    # @return [ProductType]
+    attr_accessor :product_type
+
+    # Sanitized machine-readable name of the Policy.
+    # @return [String]
+    attr_accessor :slug
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['is_default'] = 'isDefault'
+      @_hash['name'] = 'name'
+      @_hash['product_type'] = 'productType'
+      @_hash['slug'] = 'slug'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        is_default
+        name
+        product_type
+        slug
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, is_default: SKIP, name: SKIP, product_type: SKIP,
+                   slug: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @is_default = is_default unless is_default == SKIP
+      @name = name unless name == SKIP
+      @product_type = product_type unless product_type == SKIP
+      @slug = slug unless slug == 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'] : SKIP
+      is_default = hash.key?('isDefault') ? hash['isDefault'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      product_type = hash.key?('productType') ? hash['productType'] : SKIP
+      slug = hash.key?('slug') ? hash['slug'] : 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.
+      Policy.new(id: id,
+                 is_default: is_default,
+                 name: name,
+                 product_type: product_type,
+                 slug: slug,
+                 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} id: #{@id}, is_default: #{@is_default}, name: #{@name}, product_type:"\
+      " #{@product_type}, slug: #{@slug}, 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} id: #{@id.inspect}, is_default: #{@is_default.inspect}, name:"\
+      " #{@name.inspect}, product_type: #{@product_type.inspect}, slug: #{@slug.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/policy_mode.rb

@@ -0,0 +1,48 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Mode behavior: Monitor / Comment / Block / Disabled | 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 |
+  class PolicyMode
+    POLICY_MODE = [
+      # TODO: Write general description for MODE_MONITOR
+      MODE_MONITOR = 'MODE_MONITOR'.freeze,
+
+      # TODO: Write general description for MODE_COMMENT
+      MODE_COMMENT = 'MODE_COMMENT'.freeze,
+
+      # TODO: Write general description for MODE_BLOCK
+      MODE_BLOCK = 'MODE_BLOCK'.freeze,
+
+      # TODO: Write general description for MODE_DISABLED
+      MODE_DISABLED = 'MODE_DISABLED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      POLICY_MODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = MODE_MONITOR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'mode_monitor' then MODE_MONITOR
+      when 'mode_comment' then MODE_COMMENT
+      when 'mode_block' then MODE_BLOCK
+      when 'mode_disabled' then MODE_DISABLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/policy_mode1.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 policy modes to filter by
+  class PolicyMode1
+    POLICY_MODE1 = [
+      # TODO: Write general description for MONITOR
+      MONITOR = 'monitor'.freeze,
+
+      # TODO: Write general description for COMMENT
+      COMMENT = 'comment'.freeze,
+
+      # TODO: Write general description for BLOCK
+      BLOCK = 'block'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      POLICY_MODE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = MONITOR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'monitor' then MONITOR
+      when 'comment' then COMMENT
+      when 'block' then BLOCK
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/policy_mode3.rb

@@ -0,0 +1,51 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # 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 |
+  class PolicyMode3
+    POLICY_MODE3 = [
+      # TODO: Write general description for MODE_MONITOR
+      MODE_MONITOR = 'MODE_MONITOR'.freeze,
+
+      # TODO: Write general description for MODE_COMMENT
+      MODE_COMMENT = 'MODE_COMMENT'.freeze,
+
+      # TODO: Write general description for MODE_BLOCK
+      MODE_BLOCK = 'MODE_BLOCK'.freeze,
+
+      # TODO: Write general description for MODE_DISABLED
+      MODE_DISABLED = 'MODE_DISABLED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      POLICY_MODE3.include?(value)
+    end
+
+    def self.from_value(value, default_value = MODE_MONITOR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'mode_monitor' then MODE_MONITOR
+      when 'mode_comment' then MODE_COMMENT
+      when 'mode_block' then MODE_BLOCK
+      when 'mode_disabled' then MODE_DISABLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/policy_reference.rb

@@ -0,0 +1,105 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Reference to a policy, with some basic information. If null, then the
+  # information does not exist or lacks integrity (older or broken scans)
+  class PolicyReference < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique numerical identifier of the policy
+    # @return [Integer]
+    attr_accessor :id
+
+    # Human readable name
+    # @return [String]
+    attr_accessor :name
+
+    # Sanitized machine-readable name
+    # @return [String]
+    attr_accessor :slug
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['slug'] = 'slug'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        slug
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP, slug: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @slug = slug unless slug == 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'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      slug = hash.key?('slug') ? hash['slug'] : 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.
+      PolicyReference.new(id: id,
+                          name: name,
+                          slug: slug,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PolicyReference | 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} id: #{@id}, name: #{@name}, slug: #{@slug}, 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} id: #{@id.inspect}, name: #{@name.inspect}, slug: #{@slug.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/product_type.rb

@@ -0,0 +1,38 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Product type the Policy applies to. | value | description |
+  # |-------|---------------| | PRODUCT_TYPE_SAST | The product type for Code
+  # rules. | | PRODUCT_TYPE_SECRETS | The product type for Secrets rules. |
+  class ProductType
+    PRODUCT_TYPE = [
+      # TODO: Write general description for PRODUCT_TYPE_SAST
+      PRODUCT_TYPE_SAST = 'PRODUCT_TYPE_SAST'.freeze,
+
+      # TODO: Write general description for PRODUCT_TYPE_SECRETS
+      PRODUCT_TYPE_SECRETS = 'PRODUCT_TYPE_SECRETS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRODUCT_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = PRODUCT_TYPE_SAST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'product_type_sast' then PRODUCT_TYPE_SAST
+      when 'product_type_secrets' then PRODUCT_TYPE_SECRETS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/products.rb

@@ -0,0 +1,46 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Only get scans that have these enabled products | value | description |
+  # |-------|---------------| | PRODUCT_SAST |  | | PRODUCT_SCA |  | |
+  # PRODUCT_SECRETS |  | | PRODUCT_AI_SAST |  |
+  class Products
+    PRODUCTS = [
+      # TODO: Write general description for PRODUCT_SAST
+      PRODUCT_SAST = 'PRODUCT_SAST'.freeze,
+
+      # TODO: Write general description for PRODUCT_SCA
+      PRODUCT_SCA = 'PRODUCT_SCA'.freeze,
+
+      # TODO: Write general description for PRODUCT_SECRETS
+      PRODUCT_SECRETS = 'PRODUCT_SECRETS'.freeze,
+
+      # TODO: Write general description for PRODUCT_AI_SAST
+      PRODUCT_AI_SAST = 'PRODUCT_AI_SAST'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRODUCTS.include?(value)
+    end
+
+    def self.from_value(value, default_value = PRODUCT_SAST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'product_sast' then PRODUCT_SAST
+      when 'product_sca' then PRODUCT_SCA
+      when 'product_secrets' then PRODUCT_SECRETS
+      when 'product_ai_sast' then PRODUCT_AI_SAST
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/project.rb

@@ -0,0 +1,157 @@
+# 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 Project < 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
+
+    # [Beta] Configuration of Semgrep Managed Scans for the project, if
+    # relevant.
+    # @return [ManagedScanConfig]
+    attr_accessor :managed_scan_config
+
+    # 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['managed_scan_config'] = 'managed_scan_config'
+      @_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
+        managed_scan_config
+        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, managed_scan_config: 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
+      @managed_scan_config = managed_scan_config unless managed_scan_config == 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
+      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
+      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.
+      Project.new(id: id,
+                  name: name,
+                  tags: tags,
+                  created_at: created_at,
+                  default_branch: default_branch,
+                  latest_scan_at: latest_scan_at,
+                  managed_scan_config: managed_scan_config,
+                  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}, managed_scan_config: #{@managed_scan_config}, 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}, managed_scan_config: #{@managed_scan_config.inspect}, name:"\
+      " #{@name.inspect}, primary_branch: #{@primary_branch.inspect}, tags: #{@tags.inspect}, url:"\
+      " #{@url.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end