apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/create_ticket_request.rb

@@ -0,0 +1,393 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Create ticket request
+  class CreateTicketRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The autotriage verdict to filter by
+    # @return [AutotriageVerdict]
+    attr_accessor :autotriage_verdict
+
+    # List of categories to filter by
+    # @return [Array[String]]
+    attr_accessor :categories
+
+    # List of component tags to filter by
+    # @return [Array[String]]
+    attr_accessor :component_tags
+
+    # List of confidence levels to filter by
+    # @return [Confidence3]
+    attr_accessor :confidence
+
+    # Filter by dependency name. Only applies for sca findings.
+    # @return [Array[String]]
+    attr_accessor :dependencies
+
+    # Deployment slug. Can be found at `/deployments`, or in your Settings in
+    # the web UI.
+    # @return [String]
+    attr_accessor :deployment_slug
+
+    # Filter by EPSS probability (likelihood of exploit). Only applies for sca
+    # findings.
+    # @return [EpssProbability]
+    attr_accessor :epss_probability
+
+    # Filter by exposure (reachability type). Only applies for sca findings.
+    # Reachability is the ability of an attacker to access a vulnerability in a
+    # system.
+    # @return [Exposures]
+    attr_accessor :exposures
+
+    # Whether or not to group findings from the same rule and repository into a
+    # single ticket. Defaults to true.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :group_issues
+
+    # Whether to include historical findings. Only applies for secrets findings.
+    # Defaults to true.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_historical
+
+    # An array of issue IDs to act on. If this is not provided, an issue filter
+    # should be provided.
+    # @return [Array[String]]
+    attr_accessor :issue_ids
+
+    # Type of findings to create tickets for.
+    # @return [IssueType1]
+    attr_accessor :issue_type
+
+    # Optional numeric Jira project ID to associate with the created tickets. If
+    # not specified, defaults to the project configured in your integration
+    # settings. You can fetch this ID using the Jira API.
+    # @return [String]
+    attr_accessor :jira_project_id
+
+    # Max number of tickets to create. Must be an integer between 1 and 20.
+    # Defaults to 20
+    # @return [Integer]
+    attr_accessor :limit
+
+    # List of policy modes to filter by
+    # @return [Array[String]]
+    attr_accessor :policies
+
+    # List of policy modes to filter by
+    # @return [PolicyMode1]
+    attr_accessor :policy_mode
+
+    # Filter by whether a finding is only available with Semgrep Pro features.
+    # Only applies for sast findings.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :pro_only
+
+    # List of project tags to filter by
+    # @return [Array[String]]
+    attr_accessor :project_tags
+
+    # Branch reference to filter by
+    # @return [String]
+    attr_accessor :ref
+
+    # List of repository names to filter by
+    # @return [Array[String]]
+    attr_accessor :repos
+
+    # Filter by repository visibility. Only applies for secrets findings.
+    # @return [RepositoryVisibility]
+    attr_accessor :repository_visibility
+
+    # List of rule names to filter by
+    # @return [Array[String]]
+    attr_accessor :rules
+
+    # List of Semgrep Registry rulesets to filter by
+    # @return [Array[String]]
+    attr_accessor :ruleset
+
+    # Filter by type of secret (typically provider-related). Only applies for
+    # secrets findings.
+    # @return [Array[String]]
+    attr_accessor :secret_types
+
+    # List of severities to filter by
+    # @return [Severities]
+    attr_accessor :severities
+
+    # Epoch timestamp in seconds. Filters using the relevant_since field: the
+    # timestamp when this finding was detected by Semgrep (the first time, or
+    # when reintroduced).
+    # @return [String]
+    attr_accessor :since
+
+    # The status to filter by
+    # @return [Status1]
+    attr_accessor :status
+
+    # Filter by transitivity of a dependency. Only applies for sca findings.
+    # @return [Transitivities]
+    attr_accessor :transitivities
+
+    # List of triage reasons to filter by
+    # @return [TriageReasons]
+    attr_accessor :triage_reasons
+
+    # Filter by whether a secret could be validated. Only applies for secrets
+    # findings.
+    # @return [ValidationState]
+    attr_accessor :validation_state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['autotriage_verdict'] = 'autotriage_verdict'
+      @_hash['categories'] = 'categories'
+      @_hash['component_tags'] = 'component_tags'
+      @_hash['confidence'] = 'confidence'
+      @_hash['dependencies'] = 'dependencies'
+      @_hash['deployment_slug'] = 'deploymentSlug'
+      @_hash['epss_probability'] = 'epss_probability'
+      @_hash['exposures'] = 'exposures'
+      @_hash['group_issues'] = 'group_issues'
+      @_hash['include_historical'] = 'include_historical'
+      @_hash['issue_ids'] = 'issue_ids'
+      @_hash['issue_type'] = 'issue_type'
+      @_hash['jira_project_id'] = 'jira_project_id'
+      @_hash['limit'] = 'limit'
+      @_hash['policies'] = 'policies'
+      @_hash['policy_mode'] = 'policy_mode'
+      @_hash['pro_only'] = 'pro_only'
+      @_hash['project_tags'] = 'project_tags'
+      @_hash['ref'] = 'ref'
+      @_hash['repos'] = 'repos'
+      @_hash['repository_visibility'] = 'repository_visibility'
+      @_hash['rules'] = 'rules'
+      @_hash['ruleset'] = 'ruleset'
+      @_hash['secret_types'] = 'secret_types'
+      @_hash['severities'] = 'severities'
+      @_hash['since'] = 'since'
+      @_hash['status'] = 'status'
+      @_hash['transitivities'] = 'transitivities'
+      @_hash['triage_reasons'] = 'triage_reasons'
+      @_hash['validation_state'] = 'validation_state'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        autotriage_verdict
+        categories
+        component_tags
+        confidence
+        dependencies
+        epss_probability
+        exposures
+        group_issues
+        include_historical
+        issue_ids
+        jira_project_id
+        limit
+        policies
+        policy_mode
+        pro_only
+        project_tags
+        ref
+        repos
+        repository_visibility
+        rules
+        ruleset
+        secret_types
+        severities
+        since
+        status
+        transitivities
+        triage_reasons
+        validation_state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(deployment_slug:, issue_type:, autotriage_verdict: SKIP,
+                   categories: SKIP, component_tags: SKIP, confidence: SKIP,
+                   dependencies: SKIP, epss_probability: SKIP, exposures: SKIP,
+                   group_issues: true, include_historical: SKIP,
+                   issue_ids: SKIP, jira_project_id: SKIP, limit: 20,
+                   policies: SKIP, policy_mode: SKIP, pro_only: SKIP,
+                   project_tags: SKIP, ref: SKIP, repos: SKIP,
+                   repository_visibility: SKIP, rules: SKIP, ruleset: SKIP,
+                   secret_types: SKIP, severities: SKIP, since: SKIP,
+                   status: SKIP, transitivities: SKIP, triage_reasons: SKIP,
+                   validation_state: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @autotriage_verdict = autotriage_verdict unless autotriage_verdict == SKIP
+      @categories = categories unless categories == SKIP
+      @component_tags = component_tags unless component_tags == SKIP
+      @confidence = confidence unless confidence == SKIP
+      @dependencies = dependencies unless dependencies == SKIP
+      @deployment_slug = deployment_slug
+      @epss_probability = epss_probability unless epss_probability == SKIP
+      @exposures = exposures unless exposures == SKIP
+      @group_issues = group_issues unless group_issues == SKIP
+      @include_historical = include_historical unless include_historical == SKIP
+      @issue_ids = issue_ids unless issue_ids == SKIP
+      @issue_type = issue_type
+      @jira_project_id = jira_project_id unless jira_project_id == SKIP
+      @limit = limit unless limit == SKIP
+      @policies = policies unless policies == SKIP
+      @policy_mode = policy_mode unless policy_mode == SKIP
+      @pro_only = pro_only unless pro_only == SKIP
+      @project_tags = project_tags unless project_tags == SKIP
+      @ref = ref unless ref == SKIP
+      @repos = repos unless repos == SKIP
+      @repository_visibility = repository_visibility unless repository_visibility == SKIP
+      @rules = rules unless rules == SKIP
+      @ruleset = ruleset unless ruleset == SKIP
+      @secret_types = secret_types unless secret_types == SKIP
+      @severities = severities unless severities == SKIP
+      @since = since unless since == SKIP
+      @status = status unless status == SKIP
+      @transitivities = transitivities unless transitivities == SKIP
+      @triage_reasons = triage_reasons unless triage_reasons == SKIP
+      @validation_state = validation_state unless validation_state == 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
+      issue_type = hash.key?('issue_type') ? hash['issue_type'] : nil
+      autotriage_verdict =
+        hash.key?('autotriage_verdict') ? hash['autotriage_verdict'] : SKIP
+      categories = hash.key?('categories') ? hash['categories'] : SKIP
+      component_tags =
+        hash.key?('component_tags') ? hash['component_tags'] : SKIP
+      confidence = hash.key?('confidence') ? hash['confidence'] : SKIP
+      dependencies = hash.key?('dependencies') ? hash['dependencies'] : SKIP
+      epss_probability =
+        hash.key?('epss_probability') ? hash['epss_probability'] : SKIP
+      exposures = hash.key?('exposures') ? hash['exposures'] : SKIP
+      group_issues = hash['group_issues'] ||= true
+      include_historical =
+        hash.key?('include_historical') ? hash['include_historical'] : SKIP
+      issue_ids = hash.key?('issue_ids') ? hash['issue_ids'] : SKIP
+      jira_project_id =
+        hash.key?('jira_project_id') ? hash['jira_project_id'] : SKIP
+      limit = hash['limit'] ||= 20
+      policies = hash.key?('policies') ? hash['policies'] : SKIP
+      policy_mode = hash.key?('policy_mode') ? hash['policy_mode'] : SKIP
+      pro_only = hash.key?('pro_only') ? hash['pro_only'] : SKIP
+      project_tags = hash.key?('project_tags') ? hash['project_tags'] : SKIP
+      ref = hash.key?('ref') ? hash['ref'] : SKIP
+      repos = hash.key?('repos') ? hash['repos'] : SKIP
+      repository_visibility =
+        hash.key?('repository_visibility') ? hash['repository_visibility'] : SKIP
+      rules = hash.key?('rules') ? hash['rules'] : SKIP
+      ruleset = hash.key?('ruleset') ? hash['ruleset'] : SKIP
+      secret_types = hash.key?('secret_types') ? hash['secret_types'] : SKIP
+      severities = hash.key?('severities') ? hash['severities'] : SKIP
+      since = hash.key?('since') ? hash['since'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      transitivities =
+        hash.key?('transitivities') ? hash['transitivities'] : SKIP
+      triage_reasons =
+        hash.key?('triage_reasons') ? hash['triage_reasons'] : SKIP
+      validation_state =
+        hash.key?('validation_state') ? hash['validation_state'] : 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.
+      CreateTicketRequest.new(deployment_slug: deployment_slug,
+                              issue_type: issue_type,
+                              autotriage_verdict: autotriage_verdict,
+                              categories: categories,
+                              component_tags: component_tags,
+                              confidence: confidence,
+                              dependencies: dependencies,
+                              epss_probability: epss_probability,
+                              exposures: exposures,
+                              group_issues: group_issues,
+                              include_historical: include_historical,
+                              issue_ids: issue_ids,
+                              jira_project_id: jira_project_id,
+                              limit: limit,
+                              policies: policies,
+                              policy_mode: policy_mode,
+                              pro_only: pro_only,
+                              project_tags: project_tags,
+                              ref: ref,
+                              repos: repos,
+                              repository_visibility: repository_visibility,
+                              rules: rules,
+                              ruleset: ruleset,
+                              secret_types: secret_types,
+                              severities: severities,
+                              since: since,
+                              status: status,
+                              transitivities: transitivities,
+                              triage_reasons: triage_reasons,
+                              validation_state: validation_state,
+                              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} autotriage_verdict: #{@autotriage_verdict}, categories: #{@categories},"\
+      " component_tags: #{@component_tags}, confidence: #{@confidence}, dependencies:"\
+      " #{@dependencies}, deployment_slug: #{@deployment_slug}, epss_probability:"\
+      " #{@epss_probability}, exposures: #{@exposures}, group_issues: #{@group_issues},"\
+      " include_historical: #{@include_historical}, issue_ids: #{@issue_ids}, issue_type:"\
+      " #{@issue_type}, jira_project_id: #{@jira_project_id}, limit: #{@limit}, policies:"\
+      " #{@policies}, policy_mode: #{@policy_mode}, pro_only: #{@pro_only}, project_tags:"\
+      " #{@project_tags}, ref: #{@ref}, repos: #{@repos}, repository_visibility:"\
+      " #{@repository_visibility}, rules: #{@rules}, ruleset: #{@ruleset}, secret_types:"\
+      " #{@secret_types}, severities: #{@severities}, since: #{@since}, status: #{@status},"\
+      " transitivities: #{@transitivities}, triage_reasons: #{@triage_reasons}, validation_state:"\
+      " #{@validation_state}, 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} autotriage_verdict: #{@autotriage_verdict.inspect}, categories:"\
+      " #{@categories.inspect}, component_tags: #{@component_tags.inspect}, confidence:"\
+      " #{@confidence.inspect}, dependencies: #{@dependencies.inspect}, deployment_slug:"\
+      " #{@deployment_slug.inspect}, epss_probability: #{@epss_probability.inspect}, exposures:"\
+      " #{@exposures.inspect}, group_issues: #{@group_issues.inspect}, include_historical:"\
+      " #{@include_historical.inspect}, issue_ids: #{@issue_ids.inspect}, issue_type:"\
+      " #{@issue_type.inspect}, jira_project_id: #{@jira_project_id.inspect}, limit:"\
+      " #{@limit.inspect}, policies: #{@policies.inspect}, policy_mode: #{@policy_mode.inspect},"\
+      " pro_only: #{@pro_only.inspect}, project_tags: #{@project_tags.inspect}, ref:"\
+      " #{@ref.inspect}, repos: #{@repos.inspect}, repository_visibility:"\
+      " #{@repository_visibility.inspect}, rules: #{@rules.inspect}, ruleset: #{@ruleset.inspect},"\
+      " secret_types: #{@secret_types.inspect}, severities: #{@severities.inspect}, since:"\
+      " #{@since.inspect}, status: #{@status.inspect}, transitivities: #{@transitivities.inspect},"\
+      " triage_reasons: #{@triage_reasons.inspect}, validation_state:"\
+      " #{@validation_state.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/cyclonedx_version.rb

@@ -0,0 +1,48 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # 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 |  |
+  class CyclonedxVersion
+    CYCLONEDX_VERSION = [
+      # TODO: Write general description for SBOM_CYCLONE_DX_VERSION_V1_4
+      SBOM_CYCLONE_DX_VERSION_V1_4 = 'SBOM_CYCLONE_DX_VERSION_V1_4'.freeze,
+
+      # TODO: Write general description for SBOM_CYCLONE_DX_VERSION_V1_5
+      SBOM_CYCLONE_DX_VERSION_V1_5 = 'SBOM_CYCLONE_DX_VERSION_V1_5'.freeze,
+
+      # TODO: Write general description for SBOM_CYCLONE_DX_VERSION_V1_6
+      SBOM_CYCLONE_DX_VERSION_V1_6 = 'SBOM_CYCLONE_DX_VERSION_V1_6'.freeze,
+
+      # TODO: Write general description for SBOM_CYCLONE_DX_VERSION_V1_7
+      SBOM_CYCLONE_DX_VERSION_V1_7 = 'SBOM_CYCLONE_DX_VERSION_V1_7'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CYCLONEDX_VERSION.include?(value)
+    end
+
+    def self.from_value(value, default_value = SBOM_CYCLONE_DX_VERSION_V1_4)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sbom_cyclone_dx_version_v1_4' then SBOM_CYCLONE_DX_VERSION_V1_4
+      when 'sbom_cyclone_dx_version_v1_5' then SBOM_CYCLONE_DX_VERSION_V1_5
+      when 'sbom_cyclone_dx_version_v1_6' then SBOM_CYCLONE_DX_VERSION_V1_6
+      when 'sbom_cyclone_dx_version_v1_7' then SBOM_CYCLONE_DX_VERSION_V1_7
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/semgrep_web_app/models/delete_project_response.rb

@@ -0,0 +1,74 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Successfully deleted the project.
+  class DeleteProjectResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the deleted project.
+    # @return [String]
+    attr_accessor :project_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['project_name'] = 'project_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(project_name:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @project_name = project_name
+      @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_name = hash.key?('project_name') ? hash['project_name'] : 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.
+      DeleteProjectResponse.new(project_name: project_name,
+                                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_name: #{@project_name}, 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_name: #{@project_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/delete_project_tags_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 removed tags from project.
+  class DeleteProjectTagsResponse < 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.
+      DeleteProjectTagsResponse.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

data/lib/semgrep_web_app/models/deployment.rb

@@ -0,0 +1,102 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Deployment record, with relevant meta-data and further accesses.
+  class Deployment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [EndpointReference]
+    attr_accessor :findings
+
+    # Unique numerical identifier of the deployment.
+    # @return [Integer]
+    attr_accessor :id
+
+    # Human readable name.
+    # @return [String]
+    attr_accessor :name
+
+    # Sanitized machine-readable name. Used as primary identifier through the
+    # web API.
+    # @return [String]
+    attr_accessor :slug
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['findings'] = 'findings'
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['slug'] = 'slug'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        findings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, name:, slug:, findings: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @findings = findings unless findings == SKIP
+      @id = id
+      @name = name
+      @slug = slug
+      @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
+      slug = hash.key?('slug') ? hash['slug'] : nil
+      findings = EndpointReference.from_hash(hash['findings']) if hash['findings']
+
+      # 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.
+      Deployment.new(id: id,
+                     name: name,
+                     slug: slug,
+                     findings: 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} findings: #{@findings}, 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} findings: #{@findings.inspect}, id: #{@id.inspect}, name: #{@name.inspect},"\
+      " slug: #{@slug.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end