ar_v3

type AccountIdentifier = string

type ApiErrors struct {
	// Code For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported.
	Code *string `json:"code,omitempty"`

	// Message A human-readable message providing more details about the error. These messages can be shown to users.
	Message *string `json:"message,omitempty"`

	// Param If the error is parameter-specific, the parameter related to the error. For example, we can use this to display a message near the correct form field.
	Param *string `json:"param,omitempty"`

	// Type The type of error returned.
	Type ApiErrorsType `json:"type"`
}

type ApiErrorsType string

type ArtifactScan struct {
	Id              string  `json:"id"`
	LastEvaluatedAt *string `json:"lastEvaluatedAt,omitempty"`
	LastEvaluatedBy *string `json:"lastEvaluatedBy,omitempty"`

	// PackageName Package name
	PackageName string `json:"packageName"`

	// PackageType Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT. This field is extensible; clients must handle unknown values.
	PackageType PackageType `json:"packageType"`

	// PolicySets List of opa policy sets.
	PolicySets PolicySets `json:"policySets"`

	// RegistryId Registry name
	RegistryId string `json:"registryId"`

	// RegistryName Registry name
	RegistryName string `json:"registryName"`

	// ScanStatus Scan status
	ScanStatus ArtifactScanScanStatus `json:"scanStatus"`

	// Version Version
	Version string `json:"version"`

	// VersionId Version
	VersionId *string `json:"versionId,omitempty"`
}

type ArtifactScanDetails struct {
	CreatedAt *string `json:"createdAt,omitempty"`

	// FixVersionDetails Fix version Details
	FixVersionDetails *FixVersionDetails `json:"fixVersionDetails,omitempty"`

	// Id Unique identifier for this artifact scan details
	Id              openapi_types.UUID `json:"id"`
	LastEvaluatedAt *string            `json:"lastEvaluatedAt,omitempty"`

	// PackageName Package name
	PackageName string `json:"packageName"`

	// PackageType Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT. This field is extensible; clients must handle unknown values.
	PackageType             PackageType               `json:"packageType"`
	PolicySetFailureDetails *[]PolicySetFailureDetail `json:"policySetFailureDetails,omitempty"`

	// RegistryId Registry ID
	RegistryId *openapi_types.UUID `json:"registryId,omitempty"`

	// RegistryName Registry name
	RegistryName string `json:"registryName"`

	// ScanStatus Scan status
	ScanStatus ArtifactScanDetailsScanStatus `json:"scanStatus"`

	// Version Version
	Version string `json:"version"`

	// VersionId Version
	VersionId *openapi_types.UUID `json:"versionId,omitempty"`
}

type ArtifactScanDetailsResponse struct {
	// Data Artifact scans details
	Data *ArtifactScanDetails `json:"data,omitempty"`
}

type ArtifactScanDetailsScanStatus string

type ArtifactScanEvaluateRequest struct {
	// ScanId Scan identifier
	ScanId *string `json:"scanId,omitempty"`

	// VersionId Artifact version identifier
	VersionId *string `json:"versionId,omitempty"`
}

type ArtifactScanEvaluateRequestAccepted struct {
	// Data Status of the Artifact Scan Evaluate Request
	Data *ArtifactScanEvaluateRequestStatus `json:"data,omitempty"`
}

type ArtifactScanEvaluateRequestStatus string

type ArtifactScanInput struct {
	// PackageName Name of the package
	PackageName string `json:"packageName"`

	// Version Version of the package
	Version string `json:"version"`
}

type ArtifactScanScanStatus string

type BulkScanEvaluationAccepted struct {
	// Data Response data for bulk evaluation request
	Data *BulkScanEvaluationAcceptedData `json:"data,omitempty"`
}

type BulkScanEvaluationAcceptedData struct {
	// EvaluationId Unique evaluation ID for tracking the bulk evaluation
	EvaluationId *string `json:"evaluationId,omitempty"`
}

type BulkScanEvaluationRequest struct {
	// Artifacts List of artifacts to evaluate (max 50)
	Artifacts []ArtifactScanInput `json:"artifacts"`

	// RegistryId Registry identifier
	RegistryId openapi_types.UUID `json:"registryId"`
}

type BulkScanEvaluationStatusData struct {
	// Error Error message (only present when status is failure)
	Error *string `json:"error"`

	// EvaluationId The evaluation ID
	EvaluationId *string `json:"evaluationId,omitempty"`

	// Scans List of scan results (only present when status is success)
	Scans *[]BulkScanResultItem `json:"scans"`

	// Status Status of the evaluation
	Status *BulkScanEvaluationStatusDataStatus `json:"status,omitempty"`
}

type BulkScanEvaluationStatusDataStatus string

type BulkScanEvaluationStatusResponse struct {
	// Data Response data for bulk evaluation status
	Data *BulkScanEvaluationStatusData `json:"data,omitempty"`
}

type BulkScanResultItem struct {
	// PackageName Name of the package
	PackageName *string `json:"packageName,omitempty"`

	// ScanId Scan identifier
	ScanId *openapi_types.UUID `json:"scanId,omitempty"`

	// ScanStatus Scan status
	ScanStatus *BulkScanResultItemScanStatus `json:"scanStatus,omitempty"`

	// Version Version of the package
	Version *string `json:"version,omitempty"`
}

type BulkScanResultItemScanStatus string

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

type ClientInterface interface {
	// GetArtifactScans request
	GetArtifactScans(ctx context.Context, params *GetArtifactScansParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InitiateBulkScanEvaluationWithBody request with any body
	InitiateBulkScanEvaluationWithBody(ctx context.Context, params *InitiateBulkScanEvaluationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	InitiateBulkScanEvaluation(ctx context.Context, params *InitiateBulkScanEvaluationParams, body InitiateBulkScanEvaluationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBulkScanEvaluationStatus request
	GetBulkScanEvaluationStatus(ctx context.Context, evaluationId EvaluationIdParam, params *GetBulkScanEvaluationStatusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EvaluateArtifactScanWithBody request with any body
	EvaluateArtifactScanWithBody(ctx context.Context, params *EvaluateArtifactScanParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	EvaluateArtifactScan(ctx context.Context, params *EvaluateArtifactScanParams, body EvaluateArtifactScanJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetArtifactScanDetails request
	GetArtifactScanDetails(ctx context.Context, scanId ScanIDParam, params *GetArtifactScanDetailsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

type ClientOption func(*Client) error

type ClientWithResponses struct {
	ClientInterface
}

type ClientWithResponsesInterface interface {
	// GetArtifactScansWithResponse request
	GetArtifactScansWithResponse(ctx context.Context, params *GetArtifactScansParams, reqEditors ...RequestEditorFn) (*GetArtifactScansResp, error)

	// InitiateBulkScanEvaluationWithBodyWithResponse request with any body
	InitiateBulkScanEvaluationWithBodyWithResponse(ctx context.Context, params *InitiateBulkScanEvaluationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InitiateBulkScanEvaluationResp, error)

	InitiateBulkScanEvaluationWithResponse(ctx context.Context, params *InitiateBulkScanEvaluationParams, body InitiateBulkScanEvaluationJSONRequestBody, reqEditors ...RequestEditorFn) (*InitiateBulkScanEvaluationResp, error)

	// GetBulkScanEvaluationStatusWithResponse request
	GetBulkScanEvaluationStatusWithResponse(ctx context.Context, evaluationId EvaluationIdParam, params *GetBulkScanEvaluationStatusParams, reqEditors ...RequestEditorFn) (*GetBulkScanEvaluationStatusResp, error)

	// EvaluateArtifactScanWithBodyWithResponse request with any body
	EvaluateArtifactScanWithBodyWithResponse(ctx context.Context, params *EvaluateArtifactScanParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EvaluateArtifactScanResp, error)

	EvaluateArtifactScanWithResponse(ctx context.Context, params *EvaluateArtifactScanParams, body EvaluateArtifactScanJSONRequestBody, reqEditors ...RequestEditorFn) (*EvaluateArtifactScanResp, error)

	// GetArtifactScanDetailsWithResponse request
	GetArtifactScanDetailsWithResponse(ctx context.Context, scanId ScanIDParam, params *GetArtifactScanDetailsParams, reqEditors ...RequestEditorFn) (*GetArtifactScanDetailsResp, error)
}

type EvaluateArtifactScanJSONRequestBody = ArtifactScanEvaluateRequest

type EvaluateArtifactScanParams struct {
	// AccountIdentifier Unique identifier for the Harness account.
	AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
}

type EvaluateArtifactScanResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *ArtifactScanEvaluateRequestAccepted
	JSONDefault  *V3Error
}

type EvaluationIdParam = string

type FixVersionDetails struct {
	// CurrentVersion The current version
	CurrentVersion string `json:"currentVersion"`

	// FixVersion The fix version
	FixVersion *string `json:"fixVersion,omitempty"`

	// FixVersionAvailable Fix version available or not
	FixVersionAvailable bool `json:"fixVersionAvailable"`
}

type GetArtifactScanDetailsParams struct {
	// AccountIdentifier Unique identifier for the Harness account.
	AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`

	// PolicySetRef Unique reference for the opa policy set. Example: `my-policy` or `account.my-policy
	PolicySetRef *PolicySetRefParam `form:"policy_set_ref,omitempty" json:"policy_set_ref,omitempty"`
}

type GetArtifactScanDetailsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ArtifactScanDetailsResponse
	JSONDefault  *V3Error
}

type GetArtifactScansParams struct {
	// AccountIdentifier Unique identifier for the Harness account.
	AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`

	// OrgIdentifier Unique identifier for the organization within the account.
	//
	// Example: `default` or `engineering_org`
	OrgIdentifier *OrgIdentifier `form:"org_identifier,omitempty" json:"org_identifier,omitempty"`

	// ProjectIdentifier Unique identifier for the project within the organization.
	//
	// Example: `my_project` or `frontend_services`
	ProjectIdentifier *ProjectIdentifier `form:"project_identifier,omitempty" json:"project_identifier,omitempty"`

	// PackageType Registry Package Type
	PackageType *PackageTypeListParam `form:"package_type,omitempty" json:"package_type,omitempty"`

	// RegistryId Unique id for the registry.
	// Note: This parameter should have one id if package query param is provided
	RegistryId *RegistryIdListParam `form:"registry_id,omitempty" json:"registry_id,omitempty"`

	// PolicySetRef Unique reference for the opa policy set. Example: `my-policy` or `account.my-policy
	PolicySetRef *PolicySetRefParam `form:"policy_set_ref,omitempty" json:"policy_set_ref,omitempty"`

	// ScanId Scan Identifier
	ScanId *ScanIDQueryParam `form:"scan_id,omitempty" json:"scan_id,omitempty"`

	// ScanStatus Scan status of the artifact after opa policy evaluation. Note: It can only be BLOCKED or WARN
	ScanStatus *ScanStatusParam `form:"scan_status,omitempty" json:"scan_status,omitempty"`

	// Page The page number for pagination (0-indexed).
	//
	// Used to navigate through large result sets. Combined with `size` parameter
	// to control which subset of results to return.
	//
	// Example: `page=0` returns the first page, `page=1` returns the second page
	Page *PageNumber `form:"page,omitempty" json:"page,omitempty"`

	// Size The number of items to return per page.
	//
	// Controls the page size for paginated results.
	//
	// Example: `size=50` returns up to 50 items per page
	Size *PageSize `form:"size,omitempty" json:"size,omitempty"`

	// SortOrder The sort order for the results.
	//
	// Determines whether results are sorted in ascending or descending order.
	// Must be used in combination with `sort_field` parameter.
	//
	// Allowed values: `ASC` (ascending), `DESC` (descending)
	SortOrder *GetArtifactScansParamsSortOrder `form:"sort_order,omitempty" json:"sort_order,omitempty"`

	// SortField The field by which to sort the results.
	//
	// Specifies which field should be used for sorting. Available fields depend
	// on the endpoint and the type of data being returned.
	//
	// Common examples: `name`, `createdAt`, `updatedAt`
	SortField *SortField `form:"sort_field,omitempty" json:"sort_field,omitempty"`

	// SearchTerm Search term for filtering results.
	//
	// Example: `search_term=prod` might match keys like "production", "prod-env", etc.
	SearchTerm *SearchTerm `form:"search_term,omitempty" json:"search_term,omitempty"`

	// Scope **Scope of registries to list**
	// * **none** – current space only (default)   * **ancestors** – current space **plus** all parent spaces   * **descendants** – current space **plus** all child spaces
	// If omitted, `none` is assumed.
	Scope *GetArtifactScansParamsScope `form:"scope,omitempty" json:"scope,omitempty"`
}

type GetArtifactScansParamsScope string

type GetArtifactScansParamsSortOrder string

type GetArtifactScansResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListArtifactScanResponse
	JSONDefault  *V3Error
}

type GetBulkScanEvaluationStatusParams struct {
	// AccountIdentifier Unique identifier for the Harness account.
	AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`

	// OrgIdentifier Unique identifier for the organization within the account.
	//
	// Example: `default` or `engineering_org`
	OrgIdentifier *OrgIdentifier `form:"org_identifier,omitempty" json:"org_identifier,omitempty"`

	// ProjectIdentifier Unique identifier for the project within the organization.
	//
	// Example: `my_project` or `frontend_services`
	ProjectIdentifier *ProjectIdentifier `form:"project_identifier,omitempty" json:"project_identifier,omitempty"`
}

type GetBulkScanEvaluationStatusResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BulkScanEvaluationStatusResponse
	JSONDefault  *V3Error
}

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

type InitiateBulkScanEvaluationJSONRequestBody = BulkScanEvaluationRequest

type InitiateBulkScanEvaluationParams struct {
	// AccountIdentifier Unique identifier for the Harness account.
	AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`

	// OrgIdentifier Unique identifier for the organization within the account.
	//
	// Example: `default` or `engineering_org`
	OrgIdentifier *OrgIdentifier `form:"org_identifier,omitempty" json:"org_identifier,omitempty"`

	// ProjectIdentifier Unique identifier for the project within the organization.
	//
	// Example: `my_project` or `frontend_services`
	ProjectIdentifier *ProjectIdentifier `form:"project_identifier,omitempty" json:"project_identifier,omitempty"`
}

type InitiateBulkScanEvaluationResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *BulkScanEvaluationAccepted
	JSONDefault  *V3Error
}

type LicensePolicyFailureDetailConfig struct {
	// AllowedLicenses Allowed license list.
	AllowedLicenses []string `json:"allowedLicenses"`

	// BlockedLicense Blocked license.
	BlockedLicense string `json:"blockedLicense"`
}

type ListArtifactScanResponse struct {
	// Data A list of artifact scans
	Data []ArtifactScan `json:"data"`

	// ItemCount The total number of items
	ItemCount int64 `json:"itemCount"`

	// Meta Metadata about the list artifact scans
	Meta ScanMeta `json:"meta"`

	// PageCount The total number of pages
	PageCount int64 `json:"pageCount"`

	// PageIndex The current page
	PageIndex int64 `json:"pageIndex"`

	// PageSize The number of items per page
	PageSize int `json:"pageSize"`
}

type OrgIdentifier = string

type PackageAgeViolationPolicyFailureDetailConfig struct {
	// PackageAgeThreshold Package age threshold.
	PackageAgeThreshold string `json:"packageAgeThreshold"`

	// PublishedOn Package publish date.
	PublishedOn string `json:"publishedOn"`
}

type PackageType = string

type PackageTypeListParam = []string

type PageNumber = int64

type PageSize = int64

type PolicyFailureDetail struct {
	// Category Policy failure detail category.
	Category PolicyFailureDetailCategory `json:"category"`

	// PolicyName Policy name.
	PolicyName string `json:"policyName"`

	// PolicyRef Policy Ref.
	PolicyRef string `json:"policyRef"`
	// contains filtered or unexported fields
}

type PolicyFailureDetailCategory string

type PolicySetFailureDetail struct {
	PolicyFailureDetails []PolicyFailureDetail `json:"policyFailureDetails"`

	// PolicySetName Policy set name.
	PolicySetName string `json:"policySetName"`

	// PolicySetRef Policy set reference.
	PolicySetRef string `json:"policySetRef"`
}

type PolicySetRefParam = string

type PolicySets = []struct {
	// PolicySetName Policy Set name
	PolicySetName string `json:"policySetName"`

	// PolicySetRef Unique reference for the opa policy set. Example: `my-policy` or `account.my-policy`
	PolicySetRef string `json:"policySetRef"`
}

type ProjectIdentifier = string

type RegistryIdListParam = []openapi_types.UUID

type RegistryScope string

type RequestEditorFn func(ctx context.Context, req *http.Request) error

type ScanIDParam = string

type ScanIDQueryParam = string

type ScanMeta struct {
	// BlockedCount Count of active blocked artifacts
	BlockedCount *int64 `json:"blockedCount,omitempty"`

	// TotalCount Count of total artifact violations
	TotalCount *int64 `json:"totalCount,omitempty"`

	// WarnCount Count of active Warn artifacts
	WarnCount *int64 `json:"warnCount,omitempty"`
}

type ScanStatusParam = string

type SearchTerm = string

type SecurityPolicyFailureDetailConfig struct {
	// Vulnerabilities List of security violations.
	Vulnerabilities []SecurityPolicyFailureVulnerability `json:"vulnerabilities"`
}

type SecurityPolicyFailureVulnerability struct {
	// CveId CVE identifier.
	CveId string `json:"cveId"`

	// CvssScore CVSS score.
	CvssScore float64 `json:"cvssScore"`

	// CvssThreshold CVSS threshold.
	CvssThreshold float64 `json:"cvssThreshold"`
}

type SortField = string

type SortOrder string

type V3Error struct {
	Error ApiErrors `json:"error"`
}