apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/models/protos_secrets_v1_historical_info.rb

@@ -0,0 +1,116 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module SemgrepWebApp
+  # ProtosSecretsV1HistoricalInfo Model.
+  class ProtosSecretsV1HistoricalInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Git blob at which the finding is present. Sent in addition to the commit
+    #  since some SCMs have permalinks which use the blob sha, so this
+    # information
+    #  is useful when generating links back to the SCM.
+    # @return [String]
+    attr_accessor :git_blob
+
+    # Git commit at which the finding is present. Used by "historical" scans,
+    #  which scan non-HEAD commits in the git history. Relevant for finding,
+    # e.g.,
+    #  secrets which are buried in the git history which we wouldn't find at
+    # HEAD
+    # @return [String]
+    attr_accessor :git_commit
+
+    # Git commit at which the finding is present. Used by "historical" scans,
+    #  which scan non-HEAD commits in the git history. Relevant for finding,
+    # e.g.,
+    #  secrets which are buried in the git history which we wouldn't find at
+    # HEAD
+    # @return [DateTime]
+    attr_accessor :git_commit_timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['git_blob'] = 'gitBlob'
+      @_hash['git_commit'] = 'gitCommit'
+      @_hash['git_commit_timestamp'] = 'gitCommitTimestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        git_blob
+        git_commit
+        git_commit_timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(git_blob: SKIP, git_commit: SKIP, git_commit_timestamp: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @git_blob = git_blob unless git_blob == SKIP
+      @git_commit = git_commit unless git_commit == SKIP
+      @git_commit_timestamp = git_commit_timestamp unless git_commit_timestamp == 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.
+      git_blob = hash.key?('gitBlob') ? hash['gitBlob'] : SKIP
+      git_commit = hash.key?('gitCommit') ? hash['gitCommit'] : SKIP
+      git_commit_timestamp = if hash.key?('gitCommitTimestamp')
+                               (DateTimeHelper.from_rfc3339(hash['gitCommitTimestamp']) if hash['gitCommitTimestamp'])
+                             else
+                               SKIP
+                             end
+
+      # 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.
+      ProtosSecretsV1HistoricalInfo.new(git_blob: git_blob,
+                                        git_commit: git_commit,
+                                        git_commit_timestamp: git_commit_timestamp,
+                                        additional_properties: additional_properties)
+    end
+
+    def to_custom_git_commit_timestamp
+      DateTimeHelper.to_rfc3339(git_commit_timestamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} git_blob: #{@git_blob}, git_commit: #{@git_commit}, git_commit_timestamp:"\
+      " #{@git_commit_timestamp}, 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} git_blob: #{@git_blob.inspect}, git_commit: #{@git_commit.inspect},"\
+      " git_commit_timestamp: #{@git_commit_timestamp.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/protos_secrets_v1_secrets_finding.rb

@@ -0,0 +1,320 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module SemgrepWebApp
+  # A Finding represents a single secret finding.
+  class ProtosSecretsV1SecretsFinding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # * Autotriage info for the finding.
+    #  This is used for the Generic Secrets Detection project, for
+    #  autotriaging secrets findings with LLMs
+    # @return [ProtosAiV1Autotriage]
+    attr_accessor :autotriage
+
+    # Confidence of the finding.
+    # | value | description |
+    # |-------|---------------|
+    # | CONFIDENCE_HIGH |  |
+    # | CONFIDENCE_MEDIUM |  |
+    # | CONFIDENCE_LOW |  |
+    # @return [Confidence7]
+    attr_accessor :confidence
+
+    # Creation timestamp.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The external ticket reference
+    # @return [ProtosTicketingV1ExternalTicket]
+    attr_accessor :external_ticket
+
+    # File path where the finding was detected.
+    # @return [String]
+    attr_accessor :finding_path
+
+    # URL to the file where the finding was detected.
+    # @return [String]
+    attr_accessor :finding_path_url
+
+    # Historical scanning info for the finding.
+    # @return [ProtosSecretsV1HistoricalInfo]
+    attr_accessor :historical_info
+
+    # ID of the finding.
+    # @return [String]
+    attr_accessor :id
+
+    # The behavior of the finding reporting: Monitor / Comment / Block.
+    # | 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 [Mode]
+    attr_accessor :mode
+
+    # Branch where the finding was detected.
+    # @return [String]
+    attr_accessor :ref
+
+    # URL to the branch where the finding was detected.
+    # @return [String]
+    attr_accessor :ref_url
+
+    # Repository where the finding was detected.
+    # @return [ProtosSecretsV1SecretsFindingRepository]
+    attr_accessor :repository
+
+    # List of external review comment information associated with a finding
+    # @return [Array[ProtosCommonV1ReviewComment]]
+    attr_accessor :review_comments
+
+    # ID of the rule that triggered the finding.
+    # @return [String]
+    attr_accessor :rule_hash_id
+
+    # Severity of the finding.
+    # | value | description |
+    # |-------|---------------|
+    # | SEVERITY_HIGH |  |
+    # | SEVERITY_MEDIUM |  |
+    # | SEVERITY_LOW |  |
+    # | SEVERITY_CRITICAL |  |
+    # @return [Severity4]
+    attr_accessor :severity
+
+    # Status of the finding.
+    # | value | description |
+    # |-------|---------------|
+    # | FINDING_STATUS_OPEN |  |
+    # | FINDING_STATUS_IGNORED |  |
+    # | FINDING_STATUS_FIXED |  |
+    # | FINDING_STATUS_REMOVED |  |
+    # | FINDING_STATUS_UNKNOWN |  |
+    # | FINDING_STATUS_PROVISIONALLY_IGNORED |  |
+    # @return [Status6]
+    attr_accessor :status
+
+    # Service type for the secrets finding (e.g. AWS, GitHub, GitLab, etc).
+    # @return [String]
+    attr_accessor :type
+
+    # Update timestamp.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # Whether the finding was validated or not.
+    # | value | description |
+    # |-------|---------------|
+    # | VALIDATION_STATE_CONFIRMED_VALID |  |
+    # | VALIDATION_STATE_CONFIRMED_INVALID |  |
+    # | VALIDATION_STATE_VALIDATION_ERROR |  |
+    # | VALIDATION_STATE_NO_VALIDATOR |  |
+    # @return [ValidationState2]
+    attr_accessor :validation_state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['autotriage'] = 'autotriage'
+      @_hash['confidence'] = 'confidence'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['external_ticket'] = 'externalTicket'
+      @_hash['finding_path'] = 'findingPath'
+      @_hash['finding_path_url'] = 'findingPathUrl'
+      @_hash['historical_info'] = 'historicalInfo'
+      @_hash['id'] = 'id'
+      @_hash['mode'] = 'mode'
+      @_hash['ref'] = 'ref'
+      @_hash['ref_url'] = 'refUrl'
+      @_hash['repository'] = 'repository'
+      @_hash['review_comments'] = 'reviewComments'
+      @_hash['rule_hash_id'] = 'ruleHashId'
+      @_hash['severity'] = 'severity'
+      @_hash['status'] = 'status'
+      @_hash['type'] = 'type'
+      @_hash['updated_at'] = 'updatedAt'
+      @_hash['validation_state'] = 'validationState'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        autotriage
+        confidence
+        created_at
+        external_ticket
+        finding_path
+        finding_path_url
+        historical_info
+        id
+        mode
+        ref
+        ref_url
+        repository
+        review_comments
+        rule_hash_id
+        severity
+        status
+        type
+        updated_at
+        validation_state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(autotriage: SKIP, confidence: SKIP, created_at: SKIP,
+                   external_ticket: SKIP, finding_path: SKIP,
+                   finding_path_url: SKIP, historical_info: SKIP, id: SKIP,
+                   mode: SKIP, ref: SKIP, ref_url: SKIP, repository: SKIP,
+                   review_comments: SKIP, rule_hash_id: SKIP, severity: SKIP,
+                   status: SKIP, type: SKIP, updated_at: SKIP,
+                   validation_state: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @autotriage = autotriage unless autotriage == SKIP
+      @confidence = confidence unless confidence == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @external_ticket = external_ticket unless external_ticket == SKIP
+      @finding_path = finding_path unless finding_path == SKIP
+      @finding_path_url = finding_path_url unless finding_path_url == SKIP
+      @historical_info = historical_info unless historical_info == SKIP
+      @id = id unless id == SKIP
+      @mode = mode unless mode == SKIP
+      @ref = ref unless ref == SKIP
+      @ref_url = ref_url unless ref_url == SKIP
+      @repository = repository unless repository == SKIP
+      @review_comments = review_comments unless review_comments == SKIP
+      @rule_hash_id = rule_hash_id unless rule_hash_id == SKIP
+      @severity = severity unless severity == SKIP
+      @status = status unless status == SKIP
+      @type = type unless type == SKIP
+      @updated_at = updated_at unless updated_at == 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.
+      autotriage = ProtosAiV1Autotriage.from_hash(hash['autotriage']) if hash['autotriage']
+      confidence = hash.key?('confidence') ? hash['confidence'] : SKIP
+      created_at = if hash.key?('createdAt')
+                     (DateTimeHelper.from_rfc3339(hash['createdAt']) if hash['createdAt'])
+                   else
+                     SKIP
+                   end
+      external_ticket = ProtosTicketingV1ExternalTicket.from_hash(hash['externalTicket']) if
+        hash['externalTicket']
+      finding_path = hash.key?('findingPath') ? hash['findingPath'] : SKIP
+      finding_path_url =
+        hash.key?('findingPathUrl') ? hash['findingPathUrl'] : SKIP
+      historical_info = ProtosSecretsV1HistoricalInfo.from_hash(hash['historicalInfo']) if
+        hash['historicalInfo']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      mode = hash.key?('mode') ? hash['mode'] : SKIP
+      ref = hash.key?('ref') ? hash['ref'] : SKIP
+      ref_url = hash.key?('refUrl') ? hash['refUrl'] : SKIP
+      repository = ProtosSecretsV1SecretsFindingRepository.from_hash(hash['repository']) if
+        hash['repository']
+      # Parameter is an array, so we need to iterate through it
+      review_comments = nil
+      unless hash['reviewComments'].nil?
+        review_comments = []
+        hash['reviewComments'].each do |structure|
+          review_comments << (ProtosCommonV1ReviewComment.from_hash(structure) if structure)
+        end
+      end
+
+      review_comments = SKIP unless hash.key?('reviewComments')
+      rule_hash_id = hash.key?('ruleHashId') ? hash['ruleHashId'] : SKIP
+      severity = hash.key?('severity') ? hash['severity'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      updated_at = if hash.key?('updatedAt')
+                     (DateTimeHelper.from_rfc3339(hash['updatedAt']) if hash['updatedAt'])
+                   else
+                     SKIP
+                   end
+      validation_state =
+        hash.key?('validationState') ? hash['validationState'] : 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.
+      ProtosSecretsV1SecretsFinding.new(autotriage: autotriage,
+                                        confidence: confidence,
+                                        created_at: created_at,
+                                        external_ticket: external_ticket,
+                                        finding_path: finding_path,
+                                        finding_path_url: finding_path_url,
+                                        historical_info: historical_info,
+                                        id: id,
+                                        mode: mode,
+                                        ref: ref,
+                                        ref_url: ref_url,
+                                        repository: repository,
+                                        review_comments: review_comments,
+                                        rule_hash_id: rule_hash_id,
+                                        severity: severity,
+                                        status: status,
+                                        type: type,
+                                        updated_at: updated_at,
+                                        validation_state: validation_state,
+                                        additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} autotriage: #{@autotriage}, confidence: #{@confidence}, created_at:"\
+      " #{@created_at}, external_ticket: #{@external_ticket}, finding_path: #{@finding_path},"\
+      " finding_path_url: #{@finding_path_url}, historical_info: #{@historical_info}, id: #{@id},"\
+      " mode: #{@mode}, ref: #{@ref}, ref_url: #{@ref_url}, repository: #{@repository},"\
+      " review_comments: #{@review_comments}, rule_hash_id: #{@rule_hash_id}, severity:"\
+      " #{@severity}, status: #{@status}, type: #{@type}, updated_at: #{@updated_at},"\
+      " 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: #{@autotriage.inspect}, confidence: #{@confidence.inspect},"\
+      " created_at: #{@created_at.inspect}, external_ticket: #{@external_ticket.inspect},"\
+      " finding_path: #{@finding_path.inspect}, finding_path_url: #{@finding_path_url.inspect},"\
+      " historical_info: #{@historical_info.inspect}, id: #{@id.inspect}, mode: #{@mode.inspect},"\
+      " ref: #{@ref.inspect}, ref_url: #{@ref_url.inspect}, repository: #{@repository.inspect},"\
+      " review_comments: #{@review_comments.inspect}, rule_hash_id: #{@rule_hash_id.inspect},"\
+      " severity: #{@severity.inspect}, status: #{@status.inspect}, type: #{@type.inspect},"\
+      " updated_at: #{@updated_at.inspect}, validation_state: #{@validation_state.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/protos_secrets_v1_secrets_finding_repository.rb

@@ -0,0 +1,121 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Repository where the finding was detected.
+  class ProtosSecretsV1SecretsFindingRepository < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Repository name
+    # @return [String]
+    attr_accessor :name
+
+    # Provider for the finding (e.g. GitHub, GitLab, GHE, etc).
+    # | value | description |
+    # |-------|---------------|
+    # | SCM_TYPE_GITHUB | GitHub Cloud |
+    # | SCM_TYPE_GITHUB_ENTERPRISE | GitHub Enterprise |
+    # | SCM_TYPE_GITLAB | GitLab Cloud |
+    # | SCM_TYPE_GITLAB_SELFMANAGED | GitLab Self-Managed |
+    # | SCM_TYPE_BITBUCKET | Bitbucket Cloud |
+    # | SCM_TYPE_BITBUCKET_DATACENTER | Bitbucket Data Center |
+    # | SCM_TYPE_AZURE_DEVOPS | Azure DevOps |
+    # | SCM_TYPE_UNKNOWN |  |
+    # | SCM_TYPE_HARNESS | Harness |
+    # @return [ScmType]
+    attr_accessor :scm_type
+
+    # URL to the repository where the finding was detected.
+    # @return [String]
+    attr_accessor :url
+
+    # Repository visbility (e.g. public, private, unknown).
+    # | value | description |
+    # |-------|---------------|
+    # | REPOSITORY_VISIBILITY_PUBLIC |  |
+    # | REPOSITORY_VISIBILITY_PRIVATE |  |
+    # | REPOSITORY_VISIBILITY_UNKNOWN |  |
+    # @return [Visibility]
+    attr_accessor :visibility
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['scm_type'] = 'scmType'
+      @_hash['url'] = 'url'
+      @_hash['visibility'] = 'visibility'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        scm_type
+        url
+        visibility
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, scm_type: SKIP, url: SKIP, visibility: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @scm_type = scm_type unless scm_type == SKIP
+      @url = url unless url == SKIP
+      @visibility = visibility unless visibility == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      scm_type = hash.key?('scmType') ? hash['scmType'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      visibility = hash.key?('visibility') ? hash['visibility'] : 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.
+      ProtosSecretsV1SecretsFindingRepository.new(name: name,
+                                                  scm_type: scm_type,
+                                                  url: url,
+                                                  visibility: visibility,
+                                                  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} name: #{@name}, scm_type: #{@scm_type}, url: #{@url}, visibility:"\
+      " #{@visibility}, 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} name: #{@name.inspect}, scm_type: #{@scm_type.inspect}, url:"\
+      " #{@url.inspect}, visibility: #{@visibility.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/semgrep_web_app/models/protos_ticketing_v1_external_ticket.rb

@@ -0,0 +1,106 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # ProtosTicketingV1ExternalTicket Model.
+  class ProtosTicketingV1ExternalTicket < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the external ticket (e.g. for Jira, something like OPS-158).
+    # @return [String]
+    attr_accessor :external_slug
+
+    # Nango ticket id
+    # @return [String]
+    attr_accessor :id
+
+    # Semgrep issue ids that are linked to this external ticket
+    # @return [Array[String]]
+    attr_accessor :linked_issue_ids
+
+    # URL of the external ticket.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_slug'] = 'externalSlug'
+      @_hash['id'] = 'id'
+      @_hash['linked_issue_ids'] = 'linkedIssueIds'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_slug
+        id
+        linked_issue_ids
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_slug: SKIP, id: SKIP, linked_issue_ids: SKIP,
+                   url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @external_slug = external_slug unless external_slug == SKIP
+      @id = id unless id == SKIP
+      @linked_issue_ids = linked_issue_ids unless linked_issue_ids == 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.
+      external_slug = hash.key?('externalSlug') ? hash['externalSlug'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      linked_issue_ids =
+        hash.key?('linkedIssueIds') ? hash['linkedIssueIds'] : 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.
+      ProtosTicketingV1ExternalTicket.new(external_slug: external_slug,
+                                          id: id,
+                                          linked_issue_ids: linked_issue_ids,
+                                          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} external_slug: #{@external_slug}, id: #{@id}, linked_issue_ids:"\
+      " #{@linked_issue_ids}, 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} external_slug: #{@external_slug.inspect}, id: #{@id.inspect},"\
+      " linked_issue_ids: #{@linked_issue_ids.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end