local_models

type ContentAddress struct {
	// contains filtered or unexported fields
}

type CreateExcludeRule struct {
	// contains filtered or unexported fields
}

type CreateExcludeRule0 = string

type CreateObjectExcludeRule = TypesFileObjectExcludeRule

type CreateTestJSONRequestBody = TypesCreateTestAttributes

type CreateTestParams struct {
	// Version The API version requested.
	Version IoSnykApiRequestSnykApiRequestVersion `form:"version" json:"version"`

	// SnykRequestId A unique ID assigned to each API request, for tracing and troubleshooting.
	//
	// Snyk clients can optionally provide this ID.
	SnykRequestId *IoSnykApiRequestSnykApiRequestRequestId `json:"snyk-request-id,omitempty"`

	// SnykInteractionId Identifies the Snyk client interaction in which this API request occurs.
	//
	// The identifier is an opaque string. though at the time of writing it may either be a
	// uuid or a urn containing a uuid and some metadata.
	// to be safe, the
	SnykInteractionId *IoSnykApiRequestSnykApiRequestInteractionId `json:"snyk-interaction-id,omitempty"`
}

type ExcludeRule struct {
	// contains filtered or unexported fields
}

type ExcludeRule0 = string

type FindingResource TypesFindingResource

type FindingResourceOption func(*FindingResource)

type Fingerprint struct {
	// contains filtered or unexported fields
}

type GetRulesParams struct {
	// Version The API version requested.
	Version IoSnykApiRequestSnykApiRequestVersion `form:"version" json:"version"`

	// SnykRequestId A unique ID assigned to each API request, for tracing and troubleshooting.
	//
	// Snyk clients can optionally provide this ID.
	SnykRequestId *IoSnykApiRequestSnykApiRequestRequestId `json:"snyk-request-id,omitempty"`

	// SnykInteractionId Identifies the Snyk client interaction in which this API request occurs.
	//
	// The identifier is an opaque string. though at the time of writing it may either be a
	// uuid or a urn containing a uuid and some metadata.
	// to be safe, the
	SnykInteractionId *IoSnykApiRequestSnykApiRequestInteractionId `json:"snyk-interaction-id,omitempty"`
}

type GetTestParams struct {
	// Version The API version requested.
	Version IoSnykApiRequestSnykApiRequestVersion `form:"version" json:"version"`

	// SnykRequestId A unique ID assigned to each API request, for tracing and troubleshooting.
	//
	// Snyk clients can optionally provide this ID.
	SnykRequestId *IoSnykApiRequestSnykApiRequestRequestId `json:"snyk-request-id,omitempty"`

	// SnykInteractionId Identifies the Snyk client interaction in which this API request occurs.
	//
	// The identifier is an opaque string. though at the time of writing it may either be a
	// uuid or a urn containing a uuid and some metadata.
	// to be safe, the
	SnykInteractionId *IoSnykApiRequestSnykApiRequestInteractionId `json:"snyk-interaction-id,omitempty"`
}

type IoSnykApiCommonError struct {
	// Code An application-specific error code, expressed as a string value.
	Code *string `json:"code,omitempty"`

	// Detail A human-readable explanation specific to this occurrence of the problem.
	Detail string `json:"detail"`

	// Id A unique identifier for this particular occurrence of the problem.
	Id *openapi_types.UUID `json:"id,omitempty"`

	// Links A link that leads to further details about this particular occurrance of the problem.
	Links  *IoSnykApiCommonErrorLink `json:"links,omitempty"`
	Meta   *map[string]interface{}   `json:"meta,omitempty"`
	Source *struct {
		Parameter *string `json:"parameter,omitempty"`
		Pointer   *string `json:"pointer,omitempty"`
	} `json:"source,omitempty"`

	// Status The HTTP status code applicable to this problem, expressed as a string value.
	Status string `json:"status"`

	// Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
	Title *string `json:"title,omitempty"`
}

type IoSnykApiCommonErrorDocument struct {
	Errors  []IoSnykApiCommonError `json:"errors"`
	Jsonapi IoSnykApiCommonJsonApi `json:"jsonapi"`
}

type IoSnykApiCommonErrorLink struct {
	About                *LinkProperty           `json:"about,omitempty"`
	AdditionalProperties map[string]LinkProperty `json:"-"`
}

type IoSnykApiCommonJsonApi struct {
	// Version Version of the JSON API specification this server supports.
	Version IoSnykApiCommonJsonApiVersion `json:"version"`
}

type IoSnykApiCommonJsonApiVersion string

type IoSnykApiCommonLinkObject struct {
	Href IoSnykApiCommonLinkString `json:"href"`

	// Meta Free-form object that may contain non-standard information.
	Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
}

type IoSnykApiCommonLinkString = string

type IoSnykApiCommonMeta map[string]interface{}

type IoSnykApiCommonPaginatedLinks struct {
	First *LinkProperty `json:"first,omitempty"`
	Last  *LinkProperty `json:"last,omitempty"`
	Next  *LinkProperty `json:"next,omitempty"`
	Prev  *LinkProperty `json:"prev,omitempty"`
	Self  *LinkProperty `json:"self,omitempty"`
}

type IoSnykApiCommonRelatedLink struct {
	Related *LinkProperty `json:"related,omitempty"`
}

type IoSnykApiRequestPaginatedRequestEndingBefore = string

type IoSnykApiRequestPaginatedRequestLimit = int8

type IoSnykApiRequestPaginatedRequestStartingAfter = string

type IoSnykApiRequestSnykApiRequestInteractionId = string

type IoSnykApiRequestSnykApiRequestRequestId = openapi_types.UUID

type IoSnykApiRequestSnykApiRequestVersion = string

type IoSnykReactiveFindingLocation struct {
	DependencyPath *[]IoSnykReactiveScaPackage `json:"dependency_path,omitempty"`

	// SourceLocations Original locations are necessary for "existing" and "removed" findings. Locations should be available for all scan types where possible.
	SourceLocations *IoSnykReactiveFindingSourceLocation `json:"source_locations,omitempty"`
}

type IoSnykReactiveFindingSourceLocation struct {
	// Filepath Maps `sarif.Runs.Results.Location.PhysicalLocation.ArtifactLocation.URI`
	Filepath string `json:"filepath"`

	// OriginalEndColumn Maps `sarif.Runs.Results.Location.PhysicalLocation.Region.EndColumn`
	OriginalEndColumn int `json:"original_end_column"`

	// OriginalEndLine Maps `sarif.Runs.Results.Location.PhysicalLocation.Region.EndLine`
	OriginalEndLine int `json:"original_end_line"`

	// OriginalStartColumn Maps `sarif.Runs.Results.Location.PhysicalLocation.Region.StartColumn`
	OriginalStartColumn int `json:"original_start_column"`

	// OriginalStartLine Maps `sarif.Runs.Results.Location.PhysicalLocation.Region.StartLine`
	OriginalStartLine int `json:"original_start_line"`
}

type IoSnykReactiveScaPackage struct {
	PackageName    string `json:"package_name"`
	PackageVersion string `json:"package_version"`
}

type LinkProperty struct {
	// contains filtered or unexported fields
}

type ListFindingsParams struct {
	// Version The API version requested.
	Version IoSnykApiRequestSnykApiRequestVersion `form:"version" json:"version"`

	// StartingAfter Opaque pagination cursor for forward traversal.
	StartingAfter *IoSnykApiRequestPaginatedRequestStartingAfter `form:"starting_after,omitempty" json:"starting_after,omitempty"`

	// EndingBefore Opaque pagination cursor for reverse traversal.
	EndingBefore *IoSnykApiRequestPaginatedRequestEndingBefore `form:"ending_before,omitempty" json:"ending_before,omitempty"`

	// Limit The number of items to return.
	Limit *IoSnykApiRequestPaginatedRequestLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// SnykRequestId A unique ID assigned to each API request, for tracing and troubleshooting.
	//
	// Snyk clients can optionally provide this ID.
	SnykRequestId *IoSnykApiRequestSnykApiRequestRequestId `json:"snyk-request-id,omitempty"`

	// SnykInteractionId Identifies the Snyk client interaction in which this API request occurs.
	//
	// The identifier is an opaque string. though at the time of writing it may either be a
	// uuid or a urn containing a uuid and some metadata.
	// to be safe, the
	SnykInteractionId *IoSnykApiRequestSnykApiRequestInteractionId `json:"snyk-interaction-id,omitempty"`
}

type LocalFinding struct {
	Findings []FindingResource    `json:"findings"`
	Outcome  TestOutcome          `json:"outcome"`
	Rules    []TypesRules         `json:"rules"`
	Summary  TypesFindingsSummary `json:"summary"`
	Links    map[string]string    `json:"links"`
}

type ObjectExcludeRule struct {
	// contains filtered or unexported fields
}

type Package struct {
	// contains filtered or unexported fields
}

type RiskFactors struct {
	// contains filtered or unexported fields
}

type Suggestion struct {
	// contains filtered or unexported fields
}

type TestInput struct {
	// contains filtered or unexported fields
}

type TestOutcome TypesTestOutcome

type TypesBusinessCriticalityRiskFactor struct {
	Factor TypesBusinessCriticalityRiskFactorFactor `json:"factor"`
	Value  TypesBusinessCriticalityRiskFactorValue  `json:"value"`
}

type TypesBusinessCriticalityRiskFactorFactor string

type TypesBusinessCriticalityRiskFactorValue string

type TypesCodeFlow struct {
	ThreadFlows []TypesThreadFlow `json:"threadFlows"`
}

type TypesCodeSastFingerprintAssetV1 struct {
	Scheme TypesCodeSastFingerprintAssetV1Scheme `json:"scheme"`
	Value  string                                `json:"value"`
}

type TypesCodeSastFingerprintAssetV1Scheme string

type TypesCodeSastFingerprintProjectV1 struct {
	Scheme TypesCodeSastFingerprintProjectV1Scheme `json:"scheme"`
	Value  string                                  `json:"value"`
}

type TypesCodeSastFingerprintProjectV1Scheme string

type TypesCodeSastFingerprintV0 struct {
	Scheme TypesCodeSastFingerprintV0Scheme `json:"scheme"`
	Value  string                           `json:"value"`
}

type TypesCodeSastFingerprintV0Scheme string

type TypesCodeSastFingerprintV1 struct {
	Scheme TypesCodeSastFingerprintV1Scheme `json:"scheme"`
	Value  string                           `json:"value"`
}

type TypesCodeSastFingerprintV1Scheme string

type TypesComponent struct {
	// Name Name of the component. Names are free-form and semantically meaningful in the context of
	// what is being scanned, and how it is being scanned. It may or may not be a file name or path,
	// depending on what is scanned.
	Name string `json:"name"`

	// ScanType Scan type of the component.
	ScanType TypesScanType `json:"scan_type"`
}

type TypesContentAddressInput struct {
	// Spec Content address specification, which defines the target address to test, or a
	// pair of addresses to test for a differential test.
	Spec TypesContentAddressSpec      `json:"spec"`
	Type TypesContentAddressInputType `json:"type"`
}

type TypesContentAddressInputType string

type TypesContentAddressSpec struct {
	// Base Base content for a differential test. When provided,
	// FindingAttributes.delta will be set with respect to the base in results.
	//
	// Otherwise FindingAttributes.delta is left unset.
	Base *ContentAddress `json:"base,omitempty"`

	// Target Target content to be scanned for this security test.
	Target ContentAddress `json:"target"`
}

type TypesCoverage struct {
	Files       int    `json:"files"`
	IsSupported bool   `json:"isSupported"`
	Lang        string `json:"lang"`
	Type        string `json:"type"`
}

type TypesCreateTestAttributes struct {
	// Context Test context; pertinent information important to associate with the outcome
	// of the test and its further processing, but is not directly used in the
	// test.
	//
	// These are worth modeling with a concrete type, rather than as generic
	// free-form metadata to communicate to consumers of the test what values are
	// available.
	Context *TypesCreateTestContext `json:"context,omitempty"`

	// Input Test inputs; what will be tested.
	Input TestInput `json:"input"`

	// Options CreateTestOptions are arguments which configure the test and determine the
	// behavior of how it is conducted.
	//
	// Options are optional when creating a test and may be derived from other
	// sources, such as a test configuration policy if not specified. Provided
	// options may be merged with or overridden by such policy.
	//
	// In the requested Test resource, these options will reflect the effective
	// options resolved and applied to the execution of the test.
	Options *TypesCreateTestOptions `json:"options,omitempty"`
}

type TypesCreateTestContext struct {
	// GitScmBranch Git SCM branch associated with the content, if known.
	//
	// This allows providing the Git SCM branch as context in cases where the input
	// is not directly imported from a Git SCM repository.
	//
	// For example, a developer working in an IDE on a feature branch.
	GitScmBranch *string `json:"git_scm_branch,omitempty"`

	// GitScmUrl Git SCM URL associated with the content, if known.
	//
	// This allows providing the Git SCM URL as context in cases where the input
	// is not directly imported from a Git SCM repository.
	//
	// For example, a developer working in an IDE on source code which was cloned
	// from, and will be proposed for merging back into, an SCM repository.
	GitScmUrl *string `json:"git_scm_url,omitempty"`

	// SdlcStage Indicate at which point in the SDLC lifecycle the test was executed.
	SdlcStage TypesCreateTestContextSdlcStage `json:"sdlc_stage"`
}

type TypesCreateTestContextSdlcStage string

type TypesCreateTestOptions struct {
	// Exclude Files from which findings should be excluded and removed from
	// results.
	//
	// This is different from FindingAttributes.suppressions; the exclude is an
	// up-front declaration that findings in the excluded files are
	// immaterial to the test result (pass/fail), and should not be reported at all.
	//
	// Excluded files might still be used to link other files/findings though. For
	// example, a SAST (source-to-sink) or SCA analysis (transitive dependency
	// chain) might transit an excluded file, enabling discovery in a
	// non-excluded file.
	Exclude *[]CreateExcludeRule `json:"exclude,omitempty"`
}

type TypesCvssRiskFactor struct {
	// CvssVersion The CVSS version being described. This will be a published CVSS
	// specification version, such as "3.1" or "4.0"
	CvssVersion string                    `json:"cvss_version"`
	Factor      TypesCvssRiskFactorFactor `json:"factor"`

	// Vector CVSS vector string, the format of which may be CVSS specification version
	// dependent.
	//
	// See https://www.first.org/cvss/specification-document#Vector-String for
	// details.
	Vector string `json:"vector"`
}

type TypesCvssRiskFactorFactor string

type TypesEpssRiskFactor struct {
	Factor TypesEpssRiskFactorFactor `json:"factor"`
	Value  float32                   `json:"value"`
}

type TypesEpssRiskFactorFactor string

type TypesExampleCommitFix struct {
	CommitUrl string      `json:"commitUrl"`
	Lines     []TypesLine `json:"lines"`
}

type TypesFileObjectExcludeRule struct {
	Type TypesFileObjectExcludeRuleType `json:"type"`

	// Value A recursive glob matching files. Equivalent to a bare string.
	Value string `json:"value"`
}

type TypesFileObjectExcludeRuleType string

type TypesFindingAttributes struct {
	CodeFlows *[]TypesCodeFlow `json:"codeFlows,omitempty"`

	// Component Component in which the finding was discovered.
	Component TypesComponent `json:"component"`

	// Delta Represent whether a finding is net new (introduced), removed, or preserved
	// in a test involving a diff between inputs.
	//
	// Only set in a differential test conducted with respect to base content.
	Delta *TypesFindingAttributesDelta `json:"delta,omitempty"`

	// Fingerprint Natural key, or fingerprint, to identify the same Finding across multiple
	// Test runs. Unique per Test. Here's why:
	// https://github.com/snyk/pr-experience-poc/blob/main/docs/design-documents/pr-inline-comments.md#why-do-we-need-fingerprints
	Fingerprint   []Fingerprint `json:"fingerprint"`
	IsAutofixable *bool         `json:"isAutofixable,omitempty"`

	// Locations A set of locations where the result was detected. Only one location should
	// be included unless the finding can only be resolved by making a change at
	// every location.
	Locations *[]IoSnykReactiveFindingLocation `json:"locations,omitempty"`
	Message   TypesFindingMessage              `json:"message"`
	Policy    *TypesPolicyv1                   `json:"policy,omitempty"`

	// Rating The severity and risk rating of the vulnerability
	Rating      *TypesFindingRating `json:"rating,omitempty"`
	ReferenceId *TypesReferenceId   `json:"referenceId,omitempty"`

	// Suggestions Suggestions are indications given to the user that might help with
	// mitigating the finding.
	//
	// For mitigation with a higher degree of confidence, remediation and fix
	// relationship links should be used.
	Suggestions *[]Suggestion `json:"suggestions,omitempty"`

	// Suppression Reasons for why a Finding can be suppressed from a Test result. This MAY NOT be required at all, given the presentation
	Suppression *TypesSuppression `json:"suppression,omitempty"`
}

type TypesFindingAttributesDelta string

type TypesFindingCounts struct {
	// Count Net count of findings, including suppressions.
	Count uint32 `json:"count"`

	// CountAdjusted Net count of findings minus suppressions.
	CountAdjusted uint32 `json:"count_adjusted"`

	// CountBy Total finding counts (including ignores) grouped by severity and
	// possibly other factors.
	CountBy TypesFindingCounts_CountBy `json:"count_by"`

	// CountByAdjusted Net finding counts (excluding ignores) grouped by severity and possibly other
	// factors.
	CountByAdjusted TypesFindingCounts_CountByAdjusted `json:"count_by_adjusted"`

	// CountBySuppressed Net suppressed finding count, grouped by severity and possibly other factors.
	CountBySuppressed TypesFindingCounts_CountBySuppressed `json:"count_by_suppressed"`

	// CountKeyOrderAsc Ordering hint for the grouping keys in count_by.
	//
	// Record key is a well-known grouping of the resource object, matched with
	// count_by.
	//
	// Record values are arrays of known possible values for the group keys in
	// ascending order, from lowest to highest. Values other than those enumerated
	// must be tolerated; their ordering is unspecified with respect to enumerated
	// values.
	CountKeyOrderAsc TypesFindingCounts_CountKeyOrderAsc `json:"count_key_order_asc"`

	// CountSuppressed Findings excluded from the count shown to users, including ignored findings.
	CountSuppressed uint32 `json:"count_suppressed"`
}

type TypesFindingCounts_CountBy struct {
	Severity             map[string]uint32            `json:"severity"`
	AdditionalProperties map[string]map[string]uint32 `json:"-"`
}

type TypesFindingCounts_CountByAdjusted struct {
	Severity             map[string]uint32            `json:"severity"`
	AdditionalProperties map[string]map[string]uint32 `json:"-"`
}

type TypesFindingCounts_CountBySuppressed struct {
	Severity             map[string]uint32            `json:"severity"`
	AdditionalProperties map[string]map[string]uint32 `json:"-"`
}

type TypesFindingCounts_CountKeyOrderAsc struct {
	// Severity FindingCounts has a deterministic ordering for severity counts.
	Severity             []string            `json:"severity"`
	AdditionalProperties map[string][]string `json:"-"`
}

type TypesFindingMessage struct {
	// Arguments Arguments to the finding rule.
	//
	// Mapped from `sarif.Runs.Results.Message.Arguments`.
	Arguments []string `json:"arguments"`

	// Header Short text description of finding rule.
	//
	// Could be sourced from `sarif.Runs.Tool.Driver.Rules.ShortDescription.Text`.
	Header string `json:"header"`

	// Markdown Markdown description of the finding rule.
	//
	// Mapped from `sarif.Runs.Results.Message.Markdown`.
	Markdown string `json:"markdown"`

	// Text Full text description of the finding rule.
	//
	// Mapped from `sarif.Runs.Results.Message.Text`.
	Text string `json:"text"`
}

type TypesFindingNumericalRating struct {
	Factors []RiskFactors `json:"factors"`
	Score   int           `json:"score"`
}

type TypesFindingRating struct {
	// Justification Optional reason for rating the vulnerability like this
	Justification *string                      `json:"justification,omitempty"`
	Priority      *TypesFindingNumericalRating `json:"priority,omitempty"`
	Risk          *TypesFindingNumericalRating `json:"risk,omitempty"`

	// Severity A value which may be modified by enrichment stages.
	Severity struct {
		// OriginalValue Original value, if modified.
		OriginalValue *TypesFindingRatingSeverityOriginalValue `json:"original_value,omitempty"`

		// Reason Reason for the modification, if modified.
		Reason *TypesFindingRatingSeverityReason `json:"reason,omitempty"`

		// Value Current value.
		Value TypesFindingRatingSeverityValue `json:"value"`
	} `json:"severity"`
	SeverityMethod TypesFindingRatingSeverityMethod `json:"severity_method"`
}

type TypesFindingRatingSeverityMethod string

type TypesFindingRatingSeverityOriginalValue string

type TypesFindingRatingSeverityReason string

type TypesFindingRatingSeverityValue string

type TypesFindingRelationships struct {
	// Autofixes Relate to autofixes for the finding, if available.
	Autofixes *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"autofixes,omitempty"`

	// Explanation Relate to a human-readable webpage that explains the finding, if available.
	Explanation *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"explanation,omitempty"`

	// FixDetails Relate to fix information for the finding, if available.
	FixDetails *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"fix_details,omitempty"`

	// PolicyModifications Policy modifications applied to this finding, if available.
	PolicyModifications *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"policy_modifications,omitempty"`

	// RawDetails Relate to the raw scan outputs. May be SARIF, CycloneDX+VEX or other
	// scan-specific formats.
	//
	// The relationship link should point to the resource URL where the raw scan
	// output can be retrieved.
	//
	// The link MAY include a URL fragment to locate the finding's position within
	// the document object.
	//
	// For JSON-based MIME types, this fragment MUST be a JSON Pointer.
	// For XML-based MIME types, this fragment MUST be an XPath expression.
	//
	// If the fragment is specified, the fragment form MUST be compatible with all
	// of the content types advertised. For example, the link MUST NOT provide a JSON
	// Pointer fragment if an XML media type is advertised.
	RawDetails *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink                `json:"links"`
		Meta  TypesFindingRelationships_RawDetails_Meta `json:"meta"`
	} `json:"raw_details,omitempty"`

	// Remediations Relate to remediations for the finding, if available.
	Remediations *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"remediations,omitempty"`

	// SastRuleDetails Relate to details about the rule which was violated in a SAST finding.
	SastRuleDetails *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"sast_rule_details,omitempty"`

	// ScaVulnDetails Relate to details about the component vulnerability discovered in the SCA
	// finding.
	ScaVulnDetails *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"sca_vuln_details,omitempty"`
}

type TypesFindingRelationships_RawDetails_Meta struct {
	// ContentTypes Content MIME types which can be used in the Accept header when requesting the
	// related raw data.
	//
	// This property must not be empty, making explicit what type of content
	// the API client will be receiving in the raw details resource response.
	ContentTypes         []string               `json:"content_types"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

type TypesFindingResource struct {
	// Attributes A Finding entity with a common format for all types of security scans. Notably, this is a sub-resource of a Test.
	Attributes TypesFindingAttributes `json:"attributes"`

	// Id Unique identity of this Finding instance.
	Id openapi_types.UUID `json:"id"`

	// Relationships Resources which may relate to a Finding.
	Relationships TypesFindingRelationships `json:"relationships"`
	Type          TypesFindingResourceType  `json:"type"`
}

type TypesFindingResourceType string

type TypesFindingsSummary struct {
	Artifacts int                `json:"artifacts"`
	Counts    TypesFindingCounts `json:"counts"`
	Coverage  []TypesCoverage    `json:"coverage"`
	Path      string             `json:"path"`
	Type      string             `json:"type"`
}

type TypesGitCommit = string

type TypesGitSCMInput struct {
	// Spec Git SCM import specification, which defines how to import content from a Git
	// SCM repository location into a workspace for testing, or a set of workspaces
	// for differential testing.
	Spec TypesGitScmImportSpec `json:"spec"`
	Type TypesGitSCMInputType  `json:"type"`
}

type TypesGitSCMInputType string

type TypesGitScmImportSpec struct {
	// Base base is optional. If provided, it is used in supplying differential test data.
	Base *TypesGitCommit `json:"base,omitempty"`

	// Branch branch is optional. If not provided, the default branch is used.
	Branch *string `json:"branch,omitempty"`

	// Exclude Components that should be excluded when importing the SCM contents into a Workspace.
	Exclude *[]ExcludeRule `json:"exclude,omitempty"`

	// RemoteUrl Git SCM repository URL.
	RemoteUrl string `json:"remote_url"`

	// Target target is optional. If not provided the current HEAD of the selected branch is used.
	//
	// If target is provided and branch is not, no branch metadata is associated with the test.
	// If target is provided and branch is, but target is not an ancestor of branch, the wrong
	// branch will be associated with a test. It is the caller's responsibility to ensure this is correct.
	Target *TypesGitCommit `json:"target,omitempty"`
}

type TypesIdentityFingerprint struct {
	Scheme TypesIdentityFingerprintScheme `json:"scheme"`
	Value  string                         `json:"value"`
}

type TypesIdentityFingerprintScheme string

type TypesLegacyDeepcodeBundleAddress struct {
	// BundleId Legacy Deepcode bundle ID is a sha256 sum (64 hex digits).
	BundleId string                                 `json:"bundle_id"`
	Scheme   TypesLegacyDeepcodeBundleAddressScheme `json:"scheme"`
}

type TypesLegacyDeepcodeBundleAddressScheme string

type TypesLine struct {
	Line       string `json:"line"`
	LineChange string `json:"lineChange"`
	LineNumber int    `json:"lineNumber"`
}

type TypesOrgIdParam = openapi_types.UUID

type TypesOtherObjectExcludeRule struct {
	Type                 TypesOtherObjectExcludeRuleType `json:"type"`
	AdditionalProperties map[string]interface{}          `json:"-"`
}

type TypesOtherObjectExcludeRuleType string

type TypesPackageObject struct {
	// Meta Free-form metadata about this package.
	Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`

	// Name Package name, possibly with a namespace prefix.
	Name string `json:"name"`

	// Root Package management system root location.
	//
	// If set, isolates the package to a private ecosystem repository.
	//
	// Defaults to "the canonical public ecosystem repository root" for the package ecosystem type.
	Root *string `json:"root,omitempty"`

	// Subpath Sub-package qualifier, if applicable.
	Subpath *string `json:"subpath,omitempty"`

	// Type Package management system or ecosystem type.
	Type string `json:"type"`

	// Version Package version. One would hope this is semver but this generally depends
	// on the ecosystem and its package standards and requirements.
	Version string `json:"version"`
}

type TypesPackageURL = string

type TypesPolicyv1 struct {
	// OriginalLevel The original severity generated by the code scanner before any policy modifications.
	OriginalLevel    *string `json:"originalLevel,omitempty"`
	OriginalSeverity *string `json:"originalSeverity,omitempty"`
	Severity         *string `json:"severity,omitempty"`
}

type TypesReferenceId struct {
	Identifier string `json:"identifier"`
	Index      int    `json:"index"`
}

type TypesRules struct {
	DefaultConfiguration struct {
		Level string `json:"level"`
	} `json:"defaultConfiguration"`
	Help struct {
		Markdown string `json:"markdown"`
		Text     string `json:"text"`
	} `json:"help"`
	Id         string `json:"id"`
	Name       string `json:"name"`
	Properties struct {
		Categories                []string                `json:"categories"`
		Cwe                       []string                `json:"cwe"`
		ExampleCommitDescriptions []string                `json:"exampleCommitDescriptions"`
		ExampleCommitFixes        []TypesExampleCommitFix `json:"exampleCommitFixes"`
		Precision                 string                  `json:"precision"`
		RepoDatasetSize           int                     `json:"repoDatasetSize"`
		Tags                      []string                `json:"tags"`
	} `json:"properties"`
	ShortDescription struct {
		Text string `json:"text"`
	} `json:"shortDescription"`
}

type TypesRulesOption func(*TypesRules)

type TypesScaProblemFingerprint struct {
	Scheme TypesScaProblemFingerprintScheme `json:"scheme"`
	Value  string                           `json:"value"`
}

type TypesScaProblemFingerprintScheme string

type TypesScanType string

type TypesSuggestedOther struct {
	Type                 TypesSuggestedOtherType `json:"type"`
	AdditionalProperties map[string]interface{}  `json:"-"`
}

type TypesSuggestedOtherType string

type TypesSuggestedPackageUpgrade struct {
	// CurrentPackage Affected package.
	CurrentPackage Package                          `json:"current_package"`
	Type           TypesSuggestedPackageUpgradeType `json:"type"`

	// UpgradeConflicts Indicate whether the upgrade version is known to conflict with other
	// dependencies on the same package.
	//
	// If false, the upgrade does not conflict and should be applicable.
	//
	// If null or missing, conflict status is unknown or was not calculated;
	// applying the upgrade could fail.
	UpgradeConflicts *TypesSuggestedPackageUpgradeUpgradeConflicts `json:"upgrade_conflicts"`

	// UpgradePackage Upgrade package in which the vulnerability is no longer present.
	//
	// If unset, no upgrade version is available.
	UpgradePackage *Package `json:"upgrade_package,omitempty"`
}

type TypesSuggestedPackageUpgradeType string

type TypesSuggestedPackageUpgradeUpgradeConflicts bool

type TypesSuppression struct {
	// Details Suppression meta data
	Details       *TypesSuppressionDetails `json:"details,omitempty"`
	Id            *string                  `json:"id,omitempty"`
	Justification *string                  `json:"justification,omitempty"`
	Status        TypesSuppressionStatus   `json:"status"`
}

type TypesSuppressionDetails struct {
	Category   string  `json:"category"`
	Expiration *string `json:"expiration,omitempty"`

	// IgnoredBy User definition
	IgnoredBy TypesUser `json:"ignoredBy"`
	IgnoredOn string    `json:"ignoredOn"`
}

type TypesSuppressionStatus string

type TypesTestContext struct {
	// GitScmBranch Git SCM branch associated with the content, if known.
	//
	// This allows providing the Git SCM branch as context in cases where the input
	// is not directly imported from a Git SCM repository.
	//
	// For example, a developer working in an IDE on a feature branch.
	GitScmBranch *string `json:"git_scm_branch,omitempty"`

	// GitScmUrl Git SCM URL associated with the content, if known.
	//
	// This allows providing the Git SCM URL as context in cases where the input
	// is not directly imported from a Git SCM repository.
	//
	// For example, a developer working in an IDE on source code which was cloned
	// from, and will be proposed for merging back into, an SCM repository.
	GitScmUrl *string `json:"git_scm_url,omitempty"`

	// SdlcStage Indicate at which point in the SDLC lifecycle the test was executed.
	// `other` is returned if the test was created with a newer version of
	// the API including a new SDLC stage, not supported in the version of
	// the API used for retrieval.
	SdlcStage TypesTestContextSdlcStage `json:"sdlc_stage"`
}

type TypesTestContextSdlcStage string

type TypesTestError struct {
	// Code Error code, references Snyk error catalog.
	Code string `json:"code"`

	// Links Links to error detail information.
	Links *IoSnykApiCommonErrorLink `json:"links,omitempty"`

	// Meta Free-form metadata associated with the error.
	Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`

	// Reason Descriptive reason for the error.
	Reason *string `json:"reason,omitempty"`
}

type TypesTestExecStatus string

type TypesTestIdParam = openapi_types.UUID

type TypesTestOptions struct {
	// Exclude Files from which findings should be excluded and removed from
	// results.
	//
	// This is different from FindingAttributes.suppressions; the exclude is an
	// up-front declaration that findings in the excluded files are
	// immaterial to the test result (pass/fail), and should not be reported at all.
	//
	// Excluded files might still be used to link other files/findings though. For
	// example, a SAST (source-to-sink) or SCA analysis (transitive dependency
	// chain) might transit an excluded file, enabling discovery in a
	// non-excluded file.
	Exclude *[]ExcludeRule `json:"exclude,omitempty"`
}

type TypesTestOutcome struct {
	Reason *TypesTestOutcomeReason `json:"reason,omitempty"`
	Result TypesTestOutcomeResult  `json:"result"`
}

type TypesTestOutcomeReason string

type TypesTestOutcomeResult string

type TypesTestRelationships struct {
	// Findings Relationship link to the findings collection for this test.
	Findings struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"findings"`

	// Logs Relate to application-facing logs produced by the test.
	Logs *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"logs,omitempty"`
}

type TypesTestResource struct {
	// Attributes Summary-level attributes of a test.
	Attributes struct {
		// Context Test context; pertinent information important to associate with the outcome
		// of the test and its further processing, but is not directly used in the
		// test.
		//
		// These are worth modeling with a concrete type, rather than as generic
		// free-form metadata to communicate to consumers of the test what values are
		// available.
		Context *TypesTestContext `json:"context,omitempty"`

		// Options TestOptions are arguments which were used to configure the test and determine the
		// behavior of how it is conducted.
		//
		// Options are optional when creating a test and may be derived from other
		// sources, such as a test configuration policy if not specified. Provided
		// options may be merged with or overridden by such policy.
		//
		// In the requested Test resource, these options will reflect the effective
		// options resolved and applied to the execution of the test.
		Options *TypesTestOptions `json:"options,omitempty"`

		// Outcome Overall outcome of the security test: pass or fail.
		//
		// This outcome may indicate failure early even while the test is still
		// running to completion.
		Outcome TypesTestOutcome `json:"outcome"`

		// State State of the test, which should be polled to status "running" or "done"
		// before unmarshaling into this type.
		State TypesTestState `json:"state"`

		// Summary Summary of all the findings discovered by all the security scans conducted
		// for this test.
		Summary TypesFindingsSummary `json:"summary"`
	} `json:"attributes"`

	// Id Test resource ID. A unique ID assigned to each created test.
	Id openapi_types.UUID `json:"id"`

	// Relationships Resources related to a test.
	Relationships TypesTestRelationships `json:"relationships"`

	// Type Test resource type.
	Type TypesTestResourceType `json:"type"`
}

type TypesTestResourceType string

type TypesTestState struct {
	// Errors Errors that occurred during the test execution.
	Errors *TypesTestError `json:"errors,omitempty"`

	// Status Test execution status.
	Status TypesTestExecStatus `json:"status"`
}

type TypesThreadFlow struct {
	Locations []IoSnykReactiveFindingSourceLocation `json:"locations"`
}

type TypesUser struct {
	Email string `json:"email"`
	Name  string `json:"name"`
}

type TypesVulnerabilityFactRiskFactor struct {
	Factor TypesVulnerabilityFactRiskFactorFactor `json:"factor"`
	Name   string                                 `json:"name"`
	Value  bool                                   `json:"value"`
}

type TypesVulnerabilityFactRiskFactorFactor string

type TypesVulnerabilityGenericFactor struct {
	Factor TypesVulnerabilityGenericFactorFactor `json:"factor"`
	Name   string                                `json:"name"`
	Value  bool                                  `json:"value"`
}

type TypesVulnerabilityGenericFactorFactor string

type TypesVulnerabilityInstanceFactRiskFactor struct {
	Factor TypesVulnerabilityInstanceFactRiskFactorFactor `json:"factor"`
	Name   string                                         `json:"name"`
	Value  bool                                           `json:"value"`
}

type TypesVulnerabilityInstanceFactRiskFactorFactor string

type TypesWorkspaceV1Address struct {
	Scheme TypesWorkspaceV1AddressScheme `json:"scheme"`

	// WorkspaceId Workspace v1 is a sha256 sum (64 hex digits).
	WorkspaceId string `json:"workspace_id"`
}

type TypesWorkspaceV1AddressScheme string

type UnionInterface interface {
	ValueByDiscriminator() (interface{}, error)
}