v20250407

type BatchInput struct {
	// Bucket Name of the bucket where the batch file is stored
	Bucket string `json:"bucket"`

	// Path Path to the batch file within the bucket
	Path string `json:"path"`
}

type ComponentAttributes struct {
	// FindingsDocumentPath URL path for the findings document
	FindingsDocumentPath *string `json:"findings_document_path,omitempty"`

	// FindingsDocumentType Type of the findings document
	FindingsDocumentType *ComponentAttributesFindingsDocumentType `json:"findings_document_type,omitempty"`
	Id                   string                                   `json:"id"`
	Name                 *string                                  `json:"name,omitempty"`
	SeverityCounts       *SeverityCounts                          `json:"severity_counts,omitempty"`

	// Success Scan success status of the component
	Success bool `json:"success"`

	// Type Type of the component
	Type  string `json:"type"`
	Webui *WebUI `json:"webui,omitempty"`
}

type ComponentAttributesFindingsDocumentType string

type CreateBatchTestAttributes struct {
	// Initiator The type of test flow that initiated the batch
	Initiator CreateBatchTestAttributesInitiator `json:"initiator"`

	// Input Reference to the batch file in object storage
	Input BatchInput `json:"input"`

	// Scanner The scanner type to use for all tests in the batch
	Scanner CreateBatchTestAttributesScanner `json:"scanner"`
}

type CreateBatchTestAttributesInitiator string

type CreateBatchTestAttributesScanner string

type CreateBatchTestRequestBody struct {
	Data struct {
		Attributes CreateBatchTestAttributes          `json:"attributes"`
		Type       CreateBatchTestRequestBodyDataType `json:"type"`
	} `json:"data"`
}

type CreateBatchTestRequestBodyDataType string

type CreateTestRequestBody struct {
	Data struct {
		Attributes TestAttributes `json:"attributes"`

		// Id Optional identifier for the test
		Id   *openapi_types.UUID           `json:"id,omitempty"`
		Type CreateTestRequestBodyDataType `json:"type"`
	} `json:"data"`
}

type CreateTestRequestBodyDataType string

type GetComponentsResponse struct {
	Data    []GetComponentsResponseItem `json:"data"`
	Jsonapi externalRef0.JsonApi        `json:"jsonapi"`
	Links   struct {
		Next *externalRef0.LinkProperty `json:"next,omitempty"`
		Prev *externalRef0.LinkProperty `json:"prev,omitempty"`
		Self *externalRef0.LinkProperty `json:"self,omitempty"`
	} `json:"links"`
}

type GetComponentsResponseItem struct {
	Attributes ComponentAttributes           `json:"attributes"`
	Id         string                        `json:"id"`
	Type       GetComponentsResponseItemType `json:"type"`
}

type GetComponentsResponseItemType string

type OutputConfig struct {
	// AssetId The id of the asset to associate with the test.
	AssetId *openapi_types.UUID `json:"asset_id,omitempty"`

	// AssetName The name used for the asset.
	AssetName *string `json:"asset_name,omitempty"`

	// Initiator The type of test flow or system that initiated the test
	Initiator *OutputConfigInitiator `json:"initiator,omitempty"`

	// Label Arbitrary value up to the user. Deprecated: use `labels` instead.
	// Deprecated:
	Label *string `json:"label,omitempty"`

	// Labels Arbitrary string values up to the user, up to 10 keys
	Labels *map[string]string `json:"labels,omitempty"`

	// Monitor Determines if a project should be created (true) or not (false).
	Monitor *bool `json:"monitor,omitempty"`

	// Origin The source control management system or platform origin
	Origin *string `json:"origin,omitempty"`

	// ProjectBusinessCriticality Project business criticality attributes
	ProjectBusinessCriticality *[]OutputConfigProjectBusinessCriticality `json:"project_business_criticality,omitempty"`

	// ProjectEnvironment Project environment attributes
	ProjectEnvironment *[]OutputConfigProjectEnvironment `json:"project_environment,omitempty"`
	ProjectId          *openapi_types.UUID               `json:"project_id,omitempty"`

	// ProjectLifecycle Project lifecycle attributes
	ProjectLifecycle *[]OutputConfigProjectLifecycle `json:"project_lifecycle,omitempty"`
	ProjectName      *string                         `json:"project_name,omitempty"`

	// ProjectTags Project tags as an array of key=value pairs. Each tag must be in the format 'key=value'. Example: ["department=finance", "team=alpha"]
	ProjectTags *[]string `json:"project_tags,omitempty"`

	// Report Determines if the test is stateless (false) or stateful (true)
	Report     *bool   `json:"report,omitempty"`
	TargetName *string `json:"target_name,omitempty"`

	// TargetReference A reference for the target's version - can be a git branch or a commit sha
	TargetReference *string `json:"target_reference,omitempty"`
}

type OutputConfigInitiator string

type OutputConfigProjectBusinessCriticality string

type OutputConfigProjectEnvironment string

type OutputConfigProjectLifecycle string

type ResultType string

type ScanConfig struct {
	// ExclusionGlobs A list of file paths and directories to exclude from the workspace. If empty default exclusion globs apply, according to the coordinate type.
	ExclusionGlobs *[]string `json:"exclusion_globs,omitempty"`

	// InclusionGlobs A list of file paths to include in the workspace. If empty, all files are included (subject to exclusion globs).
	InclusionGlobs *[]string `json:"inclusion_globs,omitempty"`

	// LimitTestToFiles A list of file paths to use in the scan. If empty the whole target is tested.
	LimitTestToFiles *[]string `json:"limit_test_to_files,omitempty"`

	// LimitTestToProjects A list of project IDs to limit the test to. If empty, all projects are tested.
	LimitTestToProjects *[]openapi_types.UUID `json:"limit_test_to_projects,omitempty"`
	ResultType          *ResultType           `json:"result_type,omitempty"`
	Scanners            *[]ScanConfigScanners `json:"scanners,omitempty"`
}

type ScanConfigScanners string

type SeverityCounts struct {
	// Critical Number of critical severity findings
	Critical *int `json:"critical,omitempty"`

	// High Number of high severity findings
	High *int `json:"high,omitempty"`

	// Low Number of low severity findings
	Low *int `json:"low,omitempty"`

	// Medium Number of medium severity findings
	Medium *int `json:"medium,omitempty"`
}

type TestAcceptedState struct {
	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time               `json:"created_at"`
	Status    TestAcceptedStateStatus `json:"status"`
}

type TestAcceptedStateStatus string

type TestAttributes struct {
	Configuration *TestConfiguration    `json:"configuration,omitempty"`
	Input         *TestAttributes_Input `json:"input,omitempty"`
}

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

type TestCompletedState struct {
	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time `json:"created_at"`

	// Result The outcome of the test. This field is deprecated.
	// Deprecated:
	Result TestCompletedStateResult `json:"result"`
	Status TestCompletedStateStatus `json:"status"`
}

type TestCompletedStateResult string

type TestCompletedStateStatus string

type TestConfiguration struct {
	Output *OutputConfig `json:"output,omitempty"`
	Scan   *ScanConfig   `json:"scan,omitempty"`
}

type TestErrorState struct {
	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time `json:"created_at"`
	Errors    *[]struct {
		// Classification A type of error
		Classification string `json:"classification"`

		// ErrorCode The Snyk error code
		ErrorCode string `json:"error_code"`

		// InfoUrl The URL to link to more information about the error
		InfoUrl *string `json:"info_url,omitempty"`

		// Message A custom description of an error.
		Message string `json:"message"`

		// Title The high-level description of an error catalog error
		Title string `json:"title"`
	} `json:"errors,omitempty"`
	Status TestErrorStateStatus `json:"status"`
}

type TestErrorStateStatus string

type TestInProgressState struct {
	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time                 `json:"created_at"`
	Status    TestInProgressStateStatus `json:"status"`
}

type TestInProgressStateStatus string

type TestInitialConfigurationResponse struct {
	Data *struct {
		Attributes *TestAttributes                           `json:"attributes,omitempty"`
		Type       *TestInitialConfigurationResponseDataType `json:"type,omitempty"`
	} `json:"data,omitempty"`
	Jsonapi *externalRef0.JsonApi  `json:"jsonapi,omitempty"`
	Links   *externalRef0.SelfLink `json:"links,omitempty"`
}

type TestInitialConfigurationResponseDataType string

type TestInputContainerAnalysisRevision struct {
	// RevisionId A Snyk revision id referencing the uploaded container analysis
	RevisionId string                                 `json:"revision_id"`
	Type       TestInputContainerAnalysisRevisionType `json:"type"`
}

type TestInputContainerAnalysisRevisionType string

type TestInputDiffTarget struct {
	// BaseVersion SHA of the last commit existing in base branch
	BaseVersion string `json:"base_version"`

	// HeadVersion SHA of the commit to be tested
	HeadVersion string `json:"head_version"`

	// IntegrationId A Snyk integration id that has access to the target's repository.
	IntegrationId *openapi_types.UUID `json:"integration_id,omitempty"`

	// TargetId Id of the target to be tested
	TargetId openapi_types.UUID      `json:"target_id"`
	Type     TestInputDiffTargetType `json:"type"`
}

type TestInputDiffTargetType string

type TestInputGitUrlCoordinates struct {
	// IntegrationId A Snyk integration id that has access to the repository.
	IntegrationId openapi_types.UUID `json:"integration_id"`

	// RepoUrl A repository url for which a test will run.
	RepoUrl string `json:"repo_url"`

	// Revision SHA of the commit to be tested.
	Revision string                         `json:"revision"`
	Type     TestInputGitUrlCoordinatesType `json:"type"`
}

type TestInputGitUrlCoordinatesType string

type TestInputLegacyScmProject struct {
	// CommitId SHA of the commit to be tested
	CommitId string `json:"commit_id"`

	// ProjectId Id of the project to be tested
	ProjectId openapi_types.UUID            `json:"project_id"`
	Type      TestInputLegacyScmProjectType `json:"type"`
}

type TestInputLegacyScmProjectType string

type TestInputSBOMBundle struct {
	// BundleId Bundle id of the SBOM bundle
	BundleId string `json:"bundle_id"`

	// Metadata Metadata of the SBOM bundle
	Metadata struct {
		// LocalFilePath SBOM file path
		LocalFilePath string `json:"local_file_path"`
	} `json:"metadata"`
	Type TestInputSBOMBundleType `json:"type"`
}

type TestInputSBOMBundleType string

type TestInputSBOMRevision struct {
	// Metadata Metadata of the SBOM revision
	Metadata struct {
		// LocalFilePath SBOM file path
		LocalFilePath string `json:"local_file_path"`
	} `json:"metadata"`

	// RevisionId Revision id of the SBOM revision
	RevisionId openapi_types.UUID        `json:"revision_id"`
	Type       TestInputSBOMRevisionType `json:"type"`
}

type TestInputSBOMRevisionType string

type TestInputSBOMSourceBundles struct {
	Sbom struct {
		// BundleId Bundle id of the SBOM bundle
		BundleId string `json:"bundle_id"`

		// Metadata Metadata of the SBOM bundle
		Metadata struct {
			// LocalFilePath SBOM file path
			LocalFilePath string `json:"local_file_path"`
		} `json:"metadata"`
	} `json:"sbom"`
	Source struct {
		// BundleId Bundle id of the source code bundle
		BundleId string `json:"bundle_id"`

		// Metadata Metadata of the source code bundle
		Metadata struct {
			// LocalFilePath File or directory path for the source code
			LocalFilePath string `json:"local_file_path"`
		} `json:"metadata"`
	} `json:"source"`
	Type TestInputSBOMSourceBundlesType `json:"type"`
}

type TestInputSBOMSourceBundlesType string

type TestInputSBOMSourceRevisions struct {
	Sbom struct {
		// Metadata Metadata of the SBOM revision
		Metadata struct {
			// LocalFilePath SBOM file path
			LocalFilePath string `json:"local_file_path"`
		} `json:"metadata"`

		// RevisionId Revision id of the SBOM revision
		RevisionId openapi_types.UUID `json:"revision_id"`
	} `json:"sbom"`
	Source struct {
		// Metadata Metadata of the source code revision
		Metadata struct {
			// LocalFilePath File or directory path for the source code
			LocalFilePath string `json:"local_file_path"`
		} `json:"metadata"`

		// RevisionId Revision id of the source code revision
		RevisionId openapi_types.UUID `json:"revision_id"`
	} `json:"source"`
	Type TestInputSBOMSourceRevisionsType `json:"type"`
}

type TestInputSBOMSourceRevisionsType string

type TestInputScmTarget struct {
	// TargetId Id of the target to be tested
	TargetId openapi_types.UUID     `json:"target_id"`
	Type     TestInputScmTargetType `json:"type"`

	// Version This target's version, like a git branch, a commit sha, or a Docker image tag
	Version string `json:"version"`
}

type TestInputScmTargetType string

type TestInputSourceBundle struct {
	// BundleId A Snyk bundle id
	BundleId string `json:"bundle_id"`

	// Metadata Metadata of the input to be tested
	Metadata struct {
		// Branch The name of the branch being tested
		Branch *string `json:"branch,omitempty"`

		// CommitId SHA of the commit being tested
		CommitId *string `json:"commit_id,omitempty"`

		// LimitTestToFiles The findings will be limited to a subset of files only.
		LimitTestToFiles *[]string `json:"limit_test_to_files,omitempty"`

		// LocalFilePath This can be a file path or a folder id for IDE
		LocalFilePath string `json:"local_file_path"`

		// RepoUrl The repo URL of the input being tested. This is used for correlating the results of the test with the asset.
		// This will result in stable finding identities for subsequent tests of the same repository.
		RepoUrl *string `json:"repo_url,omitempty"`
	} `json:"metadata"`
	Type TestInputSourceBundleType `json:"type"`
}

type TestInputSourceBundleType string

type TestInputTarget struct {
	// TargetId Id of the target to be tested
	TargetId openapi_types.UUID  `json:"target_id"`
	Type     TestInputTargetType `json:"type"`

	// Version This target's version, like a git branch, a commit sha, or a Docker image tag
	Version string `json:"version"`
}

type TestInputTargetType string

type TestInputUploadRevision struct {
	// Metadata Metadata of the input to be tested
	Metadata *struct {
		// Branch The name of the branch being tested
		Branch *string `json:"branch,omitempty"`

		// CommitId SHA of the commit being tested
		CommitId *string `json:"commit_id,omitempty"`

		// LocalFilePath This can be a file path or a folder id for IDE
		LocalFilePath *string `json:"local_file_path,omitempty"`

		// RepoUrl The repo URL of the input being tested. This is used for correlating the results of the test with the asset.
		// This will result in stable finding identities for subsequent tests of the same repository.
		RepoUrl *string `json:"repo_url,omitempty"`
	} `json:"metadata,omitempty"`

	// RevisionId A Snyk revision id
	RevisionId string                      `json:"revision_id"`
	Type       TestInputUploadRevisionType `json:"type"`
}

type TestInputUploadRevisionType string

type TestInputWorkspace struct {
	Type TestInputWorkspaceType `json:"type"`

	// WorkspaceId Id of the workspace to be tested
	WorkspaceId openapi_types.UUID `json:"workspace_id"`
}

type TestInputWorkspaceType string

type TestResponse struct {
	Data struct {
		// Id The id of the Snyk test
		Id   openapi_types.UUID   `json:"id"`
		Type TestResponseDataType `json:"type"`
	} `json:"data"`
	Jsonapi *externalRef0.JsonApi `json:"jsonapi,omitempty"`
	Links   externalRef0.SelfLink `json:"links"`
}

type TestResponseDataType string

type TestResult struct {
	Data struct {
		Attributes TestState `json:"attributes"`

		// Id The id of the test
		Id   openapi_types.UUID `json:"id"`
		Type TestResultDataType `json:"type"`
	} `json:"data"`
	Jsonapi externalRef0.JsonApi  `json:"jsonapi"`
	Links   externalRef0.SelfLink `json:"links"`
}

type TestResultDataType string

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

type WebUI struct {
	// Link Link to the asset created in the Snyk web UI for this component
	Link *string `json:"link,omitempty"`

	// ProjectId The ID of the created project in the Snyk web UI for this component
	ProjectId *openapi_types.UUID `json:"project_id,omitempty"`

	// SnapshotId The ID of the created snapshot in the Snyk web UI for this component
	SnapshotId *openapi_types.UUID `json:"snapshot_id,omitempty"`
}