apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/protos_sca_v1_sbom_format_version.rb

@@ -0,0 +1,109 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # ProtosScaV1SbomFormatVersion Model.
+  class ProtosScaV1SbomFormatVersion < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # CycloneDX schema version for the SBOM export. Supported: 1.4, 1.5, 1.6,
+    # 1.7. Defaults to 1.4 when unset.
+    # | value | description |
+    # |-------|---------------|
+    # | SBOM_CYCLONE_DX_VERSION_V1_4 |  |
+    # | SBOM_CYCLONE_DX_VERSION_V1_5 |  |
+    # | SBOM_CYCLONE_DX_VERSION_V1_6 |  |
+    # | SBOM_CYCLONE_DX_VERSION_V1_7 |  |
+    # @return [CyclonedxVersion]
+    attr_accessor :cyclonedx_version
+
+    # Format for the SBOM export.
+    # | value | description |
+    # |-------|---------------|
+    # | SBOM_FORMAT_CYCLONEDX |  |
+    # @return [Format]
+    attr_accessor :format
+
+    # Deprecated. Use `cyclonedx_version`. Free-text CycloneDX version, e.g.
+    # "1.7".
+    # @return [String]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cyclonedx_version'] = 'cyclonedxVersion'
+      @_hash['format'] = 'format'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cyclonedx_version
+        format
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cyclonedx_version: SKIP,
+                   format: Format::SBOM_FORMAT_CYCLONEDX, version: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cyclonedx_version = cyclonedx_version unless cyclonedx_version == SKIP
+      @format = format unless format == 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.
+      cyclonedx_version =
+        hash.key?('cyclonedxVersion') ? hash['cyclonedxVersion'] : SKIP
+      format = hash['format'] ||= Format::SBOM_FORMAT_CYCLONEDX
+      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.
+      ProtosScaV1SbomFormatVersion.new(cyclonedx_version: cyclonedx_version,
+                                       format: format,
+                                       version: version,
+                                       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} cyclonedx_version: #{@cyclonedx_version}, format: #{@format}, 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} cyclonedx_version: #{@cyclonedx_version.inspect}, format:"\
+      " #{@format.inspect}, version: #{@version.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/protos_sca_v1_sbom_metadata_contact.rb

@@ -0,0 +1,95 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # ProtosScaV1SbomMetadataContact Model.
+  class ProtosScaV1SbomMetadataContact < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :email
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :phone
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['name'] = 'name'
+      @_hash['phone'] = 'phone'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email
+        name
+        phone
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email: SKIP, name: SKIP, phone: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @email = email unless email == SKIP
+      @name = name unless name == SKIP
+      @phone = phone unless phone == 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.
+      email = hash.key?('email') ? hash['email'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : 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.
+      ProtosScaV1SbomMetadataContact.new(email: email,
+                                         name: name,
+                                         phone: phone,
+                                         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} email: #{@email}, name: #{@name}, phone: #{@phone}, 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} email: #{@email.inspect}, name: #{@name.inspect}, phone: #{@phone.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/protos_sca_v1_sbom_metadata_supplier.rb

@@ -0,0 +1,95 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # ProtosScaV1SbomMetadataSupplier Model.
+  class ProtosScaV1SbomMetadataSupplier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ProtosScaV1SbomMetadataContact]
+    attr_accessor :contact
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact'] = 'contact'
+      @_hash['name'] = 'name'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact
+        name
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contact: SKIP, name: SKIP, url: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contact = contact unless contact == SKIP
+      @name = name unless name == SKIP
+      @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.
+      contact = ProtosScaV1SbomMetadataContact.from_hash(hash['contact']) if hash['contact']
+      name = hash.key?('name') ? hash['name'] : 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.
+      ProtosScaV1SbomMetadataSupplier.new(contact: contact,
+                                          name: name,
+                                          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} contact: #{@contact}, name: #{@name}, 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} contact: #{@contact.inspect}, name: #{@name.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/protos_scan_v1_scan_findings_counts.rb

@@ -0,0 +1,105 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # ProtosScanV1ScanFindingsCounts Model.
+  class ProtosScanV1ScanFindingsCounts < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total number of Code findings in the scan
+    # @return [String]
+    attr_accessor :code
+
+    # Total number of Secrets findings in the scan
+    # @return [String]
+    attr_accessor :secrets
+
+    # Total number of Supply Chain findings in the scan
+    # @return [String]
+    attr_accessor :supply_chain
+
+    # Total number of findings in the scan
+    # @return [String]
+    attr_accessor :total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['secrets'] = 'secrets'
+      @_hash['supply_chain'] = 'supply_chain'
+      @_hash['total'] = 'total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        secrets
+        supply_chain
+        total
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, secrets: SKIP, supply_chain: SKIP, total: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @secrets = secrets unless secrets == SKIP
+      @supply_chain = supply_chain unless supply_chain == SKIP
+      @total = total unless total == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      secrets = hash.key?('secrets') ? hash['secrets'] : SKIP
+      supply_chain = hash.key?('supply_chain') ? hash['supply_chain'] : SKIP
+      total = hash.key?('total') ? hash['total'] : 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.
+      ProtosScanV1ScanFindingsCounts.new(code: code,
+                                         secrets: secrets,
+                                         supply_chain: supply_chain,
+                                         total: total,
+                                         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} code: #{@code}, secrets: #{@secrets}, supply_chain: #{@supply_chain},"\
+      " total: #{@total}, 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} code: #{@code.inspect}, secrets: #{@secrets.inspect}, supply_chain:"\
+      " #{@supply_chain.inspect}, total: #{@total.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/protos_scan_v1_scan_public.rb

@@ -0,0 +1,228 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module SemgrepWebApp
+  # ProtosScanV1ScanPublic Model.
+  class ProtosScanV1ScanPublic < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The scanned branch
+    # @return [String]
+    attr_accessor :branch
+
+    # The commit hash that was scanned
+    # @return [String]
+    attr_accessor :commit
+
+    # The timestamp when this scan completed (if it has completed).
+    # @return [DateTime]
+    attr_accessor :completed_at
+
+    # Unique identifier for the deployment of the scan.
+    # @return [String]
+    attr_accessor :deployment_id
+
+    # The products used when running the scan.
+    # @return [Array[String]]
+    attr_accessor :enabled_products
+
+    # The exit_code of the scan (see
+    # https://semgrep.dev/docs/cli-reference#exit-codes)
+    # @return [String]
+    attr_accessor :exit_code
+
+    # The exit_code of the scan (see
+    # https://semgrep.dev/docs/cli-reference#exit-codes)
+    # @return [ProtosScanV1ScanFindingsCounts]
+    attr_accessor :findings_counts
+
+    # ID of the scan.
+    # @return [String]
+    attr_accessor :id
+
+    # Whether the scan was a full scan (true) or a diff scan (false)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_full_scan
+
+    # Unique identifier for the repository of the scan.
+    # @return [String]
+    attr_accessor :repository_id
+
+    # The timestamp when this scan started.
+    # @return [DateTime]
+    attr_accessor :started_at
+
+    # The current status of the scan
+    # | value | description |
+    # |-------|---------------|
+    # | SCAN_STATUS_RUNNING | The scan is currently running |
+    # | SCAN_STATUS_COMPLETED | The scan has completed successfully (0 or 1 exit
+    # code) |
+    # | SCAN_STATUS_PENDING | The scan is queued and waiting to start |
+    # | SCAN_STATUS_CANCELLED | The scan was cancelled before completion |
+    # | SCAN_STATUS_ERROR | The scan has exited with a failure (exit code not 0
+    # or 1) |
+    # | SCAN_STATUS_NEVER_FINISHED | The scan did not report an error or success
+    # after over an hour |
+    # @return [Status7]
+    attr_accessor :status
+
+    # Duration of scan, in seconds
+    # @return [Float]
+    attr_accessor :total_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['branch'] = 'branch'
+      @_hash['commit'] = 'commit'
+      @_hash['completed_at'] = 'completed_at'
+      @_hash['deployment_id'] = 'deployment_id'
+      @_hash['enabled_products'] = 'enabled_products'
+      @_hash['exit_code'] = 'exit_code'
+      @_hash['findings_counts'] = 'findings_counts'
+      @_hash['id'] = 'id'
+      @_hash['is_full_scan'] = 'is_full_scan'
+      @_hash['repository_id'] = 'repository_id'
+      @_hash['started_at'] = 'started_at'
+      @_hash['status'] = 'status'
+      @_hash['total_time'] = 'total_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        branch
+        commit
+        completed_at
+        deployment_id
+        enabled_products
+        exit_code
+        findings_counts
+        id
+        is_full_scan
+        repository_id
+        started_at
+        status
+        total_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(branch: SKIP, commit: SKIP, completed_at: SKIP,
+                   deployment_id: SKIP, enabled_products: SKIP, exit_code: SKIP,
+                   findings_counts: SKIP, id: SKIP, is_full_scan: SKIP,
+                   repository_id: SKIP, started_at: SKIP, status: SKIP,
+                   total_time: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @branch = branch unless branch == SKIP
+      @commit = commit unless commit == SKIP
+      @completed_at = completed_at unless completed_at == SKIP
+      @deployment_id = deployment_id unless deployment_id == SKIP
+      @enabled_products = enabled_products unless enabled_products == SKIP
+      @exit_code = exit_code unless exit_code == SKIP
+      @findings_counts = findings_counts unless findings_counts == SKIP
+      @id = id unless id == SKIP
+      @is_full_scan = is_full_scan unless is_full_scan == SKIP
+      @repository_id = repository_id unless repository_id == SKIP
+      @started_at = started_at unless started_at == SKIP
+      @status = status unless status == SKIP
+      @total_time = total_time unless total_time == 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.
+      branch = hash.key?('branch') ? hash['branch'] : SKIP
+      commit = hash.key?('commit') ? hash['commit'] : SKIP
+      completed_at = if hash.key?('completed_at')
+                       (DateTimeHelper.from_rfc3339(hash['completed_at']) if hash['completed_at'])
+                     else
+                       SKIP
+                     end
+      deployment_id = hash.key?('deployment_id') ? hash['deployment_id'] : SKIP
+      enabled_products =
+        hash.key?('enabled_products') ? hash['enabled_products'] : SKIP
+      exit_code = hash.key?('exit_code') ? hash['exit_code'] : SKIP
+      findings_counts = ProtosScanV1ScanFindingsCounts.from_hash(hash['findings_counts']) if
+        hash['findings_counts']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      is_full_scan = hash.key?('is_full_scan') ? hash['is_full_scan'] : SKIP
+      repository_id = hash.key?('repository_id') ? hash['repository_id'] : SKIP
+      started_at = if hash.key?('started_at')
+                     (DateTimeHelper.from_rfc3339(hash['started_at']) if hash['started_at'])
+                   else
+                     SKIP
+                   end
+      status = hash.key?('status') ? hash['status'] : SKIP
+      total_time = hash.key?('total_time') ? hash['total_time'] : 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.
+      ProtosScanV1ScanPublic.new(branch: branch,
+                                 commit: commit,
+                                 completed_at: completed_at,
+                                 deployment_id: deployment_id,
+                                 enabled_products: enabled_products,
+                                 exit_code: exit_code,
+                                 findings_counts: findings_counts,
+                                 id: id,
+                                 is_full_scan: is_full_scan,
+                                 repository_id: repository_id,
+                                 started_at: started_at,
+                                 status: status,
+                                 total_time: total_time,
+                                 additional_properties: additional_properties)
+    end
+
+    def to_custom_completed_at
+      DateTimeHelper.to_rfc3339(completed_at)
+    end
+
+    def to_custom_started_at
+      DateTimeHelper.to_rfc3339(started_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} branch: #{@branch}, commit: #{@commit}, completed_at: #{@completed_at},"\
+      " deployment_id: #{@deployment_id}, enabled_products: #{@enabled_products}, exit_code:"\
+      " #{@exit_code}, findings_counts: #{@findings_counts}, id: #{@id}, is_full_scan:"\
+      " #{@is_full_scan}, repository_id: #{@repository_id}, started_at: #{@started_at}, status:"\
+      " #{@status}, total_time: #{@total_time}, 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} branch: #{@branch.inspect}, commit: #{@commit.inspect}, completed_at:"\
+      " #{@completed_at.inspect}, deployment_id: #{@deployment_id.inspect}, enabled_products:"\
+      " #{@enabled_products.inspect}, exit_code: #{@exit_code.inspect}, findings_counts:"\
+      " #{@findings_counts.inspect}, id: #{@id.inspect}, is_full_scan: #{@is_full_scan.inspect},"\
+      " repository_id: #{@repository_id.inspect}, started_at: #{@started_at.inspect}, status:"\
+      " #{@status.inspect}, total_time: #{@total_time.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end