@sonatype/nexus-iq-api-client 0.193.0 → 0.193.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -0
- package/dist/apis/AdvancedSearchApi.d.ts +10 -10
- package/dist/apis/ApplicationCategoriesApi.d.ts +45 -45
- package/dist/apis/ApplicationReportDataApi.d.ts +25 -25
- package/dist/apis/ApplicationsApi.d.ts +40 -40
- package/dist/apis/AuditLogsApi.d.ts +5 -5
- package/dist/apis/AutoPolicyWaiverExclusionsApi.d.ts +15 -15
- package/dist/apis/AutoPolicyWaiversApi.d.ts +40 -40
- package/dist/apis/CPEMatchingConfigurationApi.d.ts +10 -10
- package/dist/apis/ClaimComponentsApi.d.ts +15 -15
- package/dist/apis/ComponentLabelsApi.d.ts +30 -30
- package/dist/apis/ComponentSearchApi.d.ts +5 -5
- package/dist/apis/ComponentsApi.d.ts +25 -25
- package/dist/apis/CompositeSourceControlApi.d.ts +5 -5
- package/dist/apis/CompositeSourceControlValidatorApi.d.ts +5 -5
- package/dist/apis/ConfigCrowdApi.d.ts +10 -10
- package/dist/apis/ConfigJiraApi.d.ts +5 -5
- package/dist/apis/ConfigMailApi.d.ts +10 -10
- package/dist/apis/ConfigProxyServerApi.d.ts +5 -5
- package/dist/apis/ConfigReverseProxyAuthenticationApi.d.ts +5 -5
- package/dist/apis/ConfigSourceControlApi.d.ts +5 -5
- package/dist/apis/ConfigZscalerApi.d.ts +20 -20
- package/dist/apis/ConfigurationApi.d.ts +15 -15
- package/dist/apis/ConfigureArtifactoryConnectionApi.d.ts +40 -40
- package/dist/apis/CycloneDXApi.d.ts +10 -10
- package/dist/apis/DataRetentionPoliciesApi.d.ts +15 -15
- package/dist/apis/DeveloperPrioritiesApi.d.ts +10 -10
- package/dist/apis/EndpointsApi.d.ts +5 -5
- package/dist/apis/FeatureConfigurationApi.d.ts +10 -10
- package/dist/apis/FirewallApi.d.ts +70 -70
- package/dist/apis/LicenseLegalMetadataApi.d.ts +40 -40
- package/dist/apis/LicenseLegalMetadataTemplatesApi.d.ts +15 -15
- package/dist/apis/LicenseOverridesApi.d.ts +20 -20
- package/dist/apis/OrganizationsApi.d.ts +25 -25
- package/dist/apis/PolicyEvaluationApi.d.ts +25 -25
- package/dist/apis/PolicyViolationDetailsApi.d.ts +45 -45
- package/dist/apis/PolicyWaiverRequestsApi.d.ts +20 -20
- package/dist/apis/PolicyWaiversApi.d.ts +45 -45
- package/dist/apis/ProductLicenseApi.d.ts +67 -0
- package/dist/apis/ProductLicenseApi.js +105 -0
- package/dist/apis/ReportsApi.d.ts +20 -20
- package/dist/apis/RepositoriesApi.d.ts +10 -10
- package/dist/apis/RoleMembershipsApi.d.ts +30 -30
- package/dist/apis/SBOMApi.d.ts +45 -45
- package/dist/apis/SPDXApi.d.ts +10 -10
- package/dist/apis/SecurityVulnerabilityOverridesApi.d.ts +5 -5
- package/dist/apis/SolutionsApi.d.ts +5 -5
- package/dist/apis/SourceControlApi.d.ts +40 -40
- package/dist/apis/SourceControlMetricsApi.d.ts +5 -5
- package/dist/apis/ThirdPartyAnalysisApi.d.ts +10 -10
- package/dist/apis/UserTokensApi.d.ts +15 -15
- package/dist/apis/UsersApi.d.ts +25 -25
- package/dist/apis/VulnerabilityDetailsApi.d.ts +5 -5
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/AdvancedSearchApi.d.ts +10 -10
- package/dist/esm/apis/ApplicationCategoriesApi.d.ts +45 -45
- package/dist/esm/apis/ApplicationReportDataApi.d.ts +25 -25
- package/dist/esm/apis/ApplicationsApi.d.ts +40 -40
- package/dist/esm/apis/AuditLogsApi.d.ts +5 -5
- package/dist/esm/apis/AutoPolicyWaiverExclusionsApi.d.ts +15 -15
- package/dist/esm/apis/AutoPolicyWaiversApi.d.ts +40 -40
- package/dist/esm/apis/CPEMatchingConfigurationApi.d.ts +10 -10
- package/dist/esm/apis/ClaimComponentsApi.d.ts +15 -15
- package/dist/esm/apis/ComponentLabelsApi.d.ts +30 -30
- package/dist/esm/apis/ComponentSearchApi.d.ts +5 -5
- package/dist/esm/apis/ComponentsApi.d.ts +25 -25
- package/dist/esm/apis/CompositeSourceControlApi.d.ts +5 -5
- package/dist/esm/apis/CompositeSourceControlValidatorApi.d.ts +5 -5
- package/dist/esm/apis/ConfigCrowdApi.d.ts +10 -10
- package/dist/esm/apis/ConfigJiraApi.d.ts +5 -5
- package/dist/esm/apis/ConfigMailApi.d.ts +10 -10
- package/dist/esm/apis/ConfigProxyServerApi.d.ts +5 -5
- package/dist/esm/apis/ConfigReverseProxyAuthenticationApi.d.ts +5 -5
- package/dist/esm/apis/ConfigSourceControlApi.d.ts +5 -5
- package/dist/esm/apis/ConfigZscalerApi.d.ts +20 -20
- package/dist/esm/apis/ConfigurationApi.d.ts +15 -15
- package/dist/esm/apis/ConfigureArtifactoryConnectionApi.d.ts +40 -40
- package/dist/esm/apis/CycloneDXApi.d.ts +10 -10
- package/dist/esm/apis/DataRetentionPoliciesApi.d.ts +15 -15
- package/dist/esm/apis/DeveloperPrioritiesApi.d.ts +10 -10
- package/dist/esm/apis/EndpointsApi.d.ts +5 -5
- package/dist/esm/apis/FeatureConfigurationApi.d.ts +10 -10
- package/dist/esm/apis/FirewallApi.d.ts +70 -70
- package/dist/esm/apis/LicenseLegalMetadataApi.d.ts +40 -40
- package/dist/esm/apis/LicenseLegalMetadataTemplatesApi.d.ts +15 -15
- package/dist/esm/apis/LicenseOverridesApi.d.ts +20 -20
- package/dist/esm/apis/OrganizationsApi.d.ts +25 -25
- package/dist/esm/apis/PolicyEvaluationApi.d.ts +25 -25
- package/dist/esm/apis/PolicyViolationDetailsApi.d.ts +45 -45
- package/dist/esm/apis/PolicyWaiverRequestsApi.d.ts +20 -20
- package/dist/esm/apis/PolicyWaiversApi.d.ts +45 -45
- package/dist/esm/apis/ProductLicenseApi.d.ts +67 -0
- package/dist/esm/apis/ProductLicenseApi.js +101 -0
- package/dist/esm/apis/ReportsApi.d.ts +20 -20
- package/dist/esm/apis/RepositoriesApi.d.ts +10 -10
- package/dist/esm/apis/RoleMembershipsApi.d.ts +30 -30
- package/dist/esm/apis/SBOMApi.d.ts +45 -45
- package/dist/esm/apis/SPDXApi.d.ts +10 -10
- package/dist/esm/apis/SecurityVulnerabilityOverridesApi.d.ts +5 -5
- package/dist/esm/apis/SolutionsApi.d.ts +5 -5
- package/dist/esm/apis/SourceControlApi.d.ts +40 -40
- package/dist/esm/apis/SourceControlMetricsApi.d.ts +5 -5
- package/dist/esm/apis/ThirdPartyAnalysisApi.d.ts +10 -10
- package/dist/esm/apis/UserTokensApi.d.ts +15 -15
- package/dist/esm/apis/UsersApi.d.ts +25 -25
- package/dist/esm/apis/VulnerabilityDetailsApi.d.ts +5 -5
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/InstallLicenseRequest.d.ts +32 -0
- package/dist/esm/models/InstallLicenseRequest.js +41 -0
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/models/InstallLicenseRequest.d.ts +32 -0
- package/dist/models/InstallLicenseRequest.js +48 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/AdvancedSearchApi.ts +10 -10
- package/src/apis/ApplicationCategoriesApi.ts +45 -45
- package/src/apis/ApplicationReportDataApi.ts +25 -25
- package/src/apis/ApplicationsApi.ts +40 -40
- package/src/apis/AuditLogsApi.ts +5 -5
- package/src/apis/AutoPolicyWaiverExclusionsApi.ts +15 -15
- package/src/apis/AutoPolicyWaiversApi.ts +40 -40
- package/src/apis/CPEMatchingConfigurationApi.ts +10 -10
- package/src/apis/ClaimComponentsApi.ts +15 -15
- package/src/apis/ComponentLabelsApi.ts +30 -30
- package/src/apis/ComponentSearchApi.ts +5 -5
- package/src/apis/ComponentsApi.ts +25 -25
- package/src/apis/CompositeSourceControlApi.ts +5 -5
- package/src/apis/CompositeSourceControlValidatorApi.ts +5 -5
- package/src/apis/ConfigCrowdApi.ts +10 -10
- package/src/apis/ConfigJiraApi.ts +5 -5
- package/src/apis/ConfigMailApi.ts +10 -10
- package/src/apis/ConfigProxyServerApi.ts +5 -5
- package/src/apis/ConfigReverseProxyAuthenticationApi.ts +5 -5
- package/src/apis/ConfigSourceControlApi.ts +5 -5
- package/src/apis/ConfigZscalerApi.ts +20 -20
- package/src/apis/ConfigurationApi.ts +15 -15
- package/src/apis/ConfigureArtifactoryConnectionApi.ts +40 -40
- package/src/apis/CycloneDXApi.ts +10 -10
- package/src/apis/DataRetentionPoliciesApi.ts +15 -15
- package/src/apis/DeveloperPrioritiesApi.ts +10 -10
- package/src/apis/EndpointsApi.ts +5 -5
- package/src/apis/FeatureConfigurationApi.ts +10 -10
- package/src/apis/FirewallApi.ts +70 -70
- package/src/apis/LicenseLegalMetadataApi.ts +40 -40
- package/src/apis/LicenseLegalMetadataTemplatesApi.ts +15 -15
- package/src/apis/LicenseOverridesApi.ts +20 -20
- package/src/apis/OrganizationsApi.ts +25 -25
- package/src/apis/PolicyEvaluationApi.ts +25 -25
- package/src/apis/PolicyViolationDetailsApi.ts +45 -45
- package/src/apis/PolicyWaiverRequestsApi.ts +20 -20
- package/src/apis/PolicyWaiversApi.ts +45 -45
- package/src/apis/ProductLicenseApi.ts +140 -0
- package/src/apis/ReportsApi.ts +20 -20
- package/src/apis/RepositoriesApi.ts +10 -10
- package/src/apis/RoleMembershipsApi.ts +30 -30
- package/src/apis/SBOMApi.ts +45 -45
- package/src/apis/SPDXApi.ts +10 -10
- package/src/apis/SecurityVulnerabilityOverridesApi.ts +5 -5
- package/src/apis/SolutionsApi.ts +5 -5
- package/src/apis/SourceControlApi.ts +40 -40
- package/src/apis/SourceControlMetricsApi.ts +5 -5
- package/src/apis/ThirdPartyAnalysisApi.ts +10 -10
- package/src/apis/UserTokensApi.ts +15 -15
- package/src/apis/UsersApi.ts +25 -25
- package/src/apis/VulnerabilityDetailsApi.ts +5 -5
- package/src/apis/index.ts +1 -0
- package/src/models/InstallLicenseRequest.ts +65 -0
- package/src/models/index.ts +1 -0
|
@@ -11,19 +11,19 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import type { ApiOrganizationDTO, ApiOrganizationListDTO } from '../models/index';
|
|
14
|
-
export interface
|
|
14
|
+
export interface OrganizationsApiAddOrganizationRequest {
|
|
15
15
|
apiOrganizationDTO?: ApiOrganizationDTO;
|
|
16
16
|
}
|
|
17
|
-
export interface
|
|
17
|
+
export interface OrganizationsApiDeleteOrganizationRequest {
|
|
18
18
|
organizationId: string;
|
|
19
19
|
}
|
|
20
|
-
export interface
|
|
20
|
+
export interface OrganizationsApiGetOrganizationRequest {
|
|
21
21
|
organizationId: string;
|
|
22
22
|
}
|
|
23
|
-
export interface
|
|
23
|
+
export interface OrganizationsApiGetOrganizationsRequest {
|
|
24
24
|
organizationName?: Set<string>;
|
|
25
25
|
}
|
|
26
|
-
export interface
|
|
26
|
+
export interface OrganizationsApiMoveOrganizationRequest {
|
|
27
27
|
organizationId: string;
|
|
28
28
|
destinationId: string;
|
|
29
29
|
failEarlyOnError?: boolean;
|
|
@@ -42,11 +42,11 @@ export interface OrganizationsApiInterface {
|
|
|
42
42
|
* @throws {RequiredError}
|
|
43
43
|
* @memberof OrganizationsApiInterface
|
|
44
44
|
*/
|
|
45
|
-
addOrganizationRaw(requestParameters:
|
|
45
|
+
addOrganizationRaw(requestParameters: OrganizationsApiAddOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiOrganizationDTO>>;
|
|
46
46
|
/**
|
|
47
47
|
* Use this method to add a new organization. Permissions required: Edit IQ Elements
|
|
48
48
|
*/
|
|
49
|
-
addOrganization(requestParameters:
|
|
49
|
+
addOrganization(requestParameters: OrganizationsApiAddOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiOrganizationDTO>;
|
|
50
50
|
/**
|
|
51
51
|
* Use this method to delete an existing organization, by providing the organization id. Permissions required: Edit IQ Elements
|
|
52
52
|
* @param {string} organizationId Enter the organization id to be deleted.
|
|
@@ -54,11 +54,11 @@ export interface OrganizationsApiInterface {
|
|
|
54
54
|
* @throws {RequiredError}
|
|
55
55
|
* @memberof OrganizationsApiInterface
|
|
56
56
|
*/
|
|
57
|
-
deleteOrganizationRaw(requestParameters:
|
|
57
|
+
deleteOrganizationRaw(requestParameters: OrganizationsApiDeleteOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
58
58
|
/**
|
|
59
59
|
* Use this method to delete an existing organization, by providing the organization id. Permissions required: Edit IQ Elements
|
|
60
60
|
*/
|
|
61
|
-
deleteOrganization(requestParameters:
|
|
61
|
+
deleteOrganization(requestParameters: OrganizationsApiDeleteOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
62
62
|
/**
|
|
63
63
|
* Use this method to retrieve the details of an organization by providing the organization id. Permissions required: View IQ Elements
|
|
64
64
|
* @param {string} organizationId Enter the organization id.
|
|
@@ -66,11 +66,11 @@ export interface OrganizationsApiInterface {
|
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
* @memberof OrganizationsApiInterface
|
|
68
68
|
*/
|
|
69
|
-
getOrganizationRaw(requestParameters:
|
|
69
|
+
getOrganizationRaw(requestParameters: OrganizationsApiGetOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiOrganizationDTO>>;
|
|
70
70
|
/**
|
|
71
71
|
* Use this method to retrieve the details of an organization by providing the organization id. Permissions required: View IQ Elements
|
|
72
72
|
*/
|
|
73
|
-
getOrganization(requestParameters:
|
|
73
|
+
getOrganization(requestParameters: OrganizationsApiGetOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiOrganizationDTO>;
|
|
74
74
|
/**
|
|
75
75
|
* Use this method to retrieve organizations with names matching those specified or all if not specified. Permissions required: View IQ Elements
|
|
76
76
|
* @param {Set<string>} [organizationName] Enter the organization names.
|
|
@@ -78,11 +78,11 @@ export interface OrganizationsApiInterface {
|
|
|
78
78
|
* @throws {RequiredError}
|
|
79
79
|
* @memberof OrganizationsApiInterface
|
|
80
80
|
*/
|
|
81
|
-
getOrganizationsRaw(requestParameters:
|
|
81
|
+
getOrganizationsRaw(requestParameters: OrganizationsApiGetOrganizationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiOrganizationListDTO>>;
|
|
82
82
|
/**
|
|
83
83
|
* Use this method to retrieve organizations with names matching those specified or all if not specified. Permissions required: View IQ Elements
|
|
84
84
|
*/
|
|
85
|
-
getOrganizations(requestParameters:
|
|
85
|
+
getOrganizations(requestParameters: OrganizationsApiGetOrganizationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiOrganizationListDTO>;
|
|
86
86
|
/**
|
|
87
87
|
* Use this method to change the parent organization. Permissions required: Edit IQ Elements
|
|
88
88
|
* @param {string} organizationId Enter the id for the organization to be moved under the new parent.
|
|
@@ -92,11 +92,11 @@ export interface OrganizationsApiInterface {
|
|
|
92
92
|
* @throws {RequiredError}
|
|
93
93
|
* @memberof OrganizationsApiInterface
|
|
94
94
|
*/
|
|
95
|
-
moveOrganizationRaw(requestParameters:
|
|
95
|
+
moveOrganizationRaw(requestParameters: OrganizationsApiMoveOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
96
96
|
/**
|
|
97
97
|
* Use this method to change the parent organization. Permissions required: Edit IQ Elements
|
|
98
98
|
*/
|
|
99
|
-
moveOrganization(requestParameters:
|
|
99
|
+
moveOrganization(requestParameters: OrganizationsApiMoveOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
102
|
*
|
|
@@ -105,41 +105,41 @@ export declare class OrganizationsApi extends runtime.BaseAPI implements Organiz
|
|
|
105
105
|
/**
|
|
106
106
|
* Use this method to add a new organization. Permissions required: Edit IQ Elements
|
|
107
107
|
*/
|
|
108
|
-
addOrganizationRaw(requestParameters:
|
|
108
|
+
addOrganizationRaw(requestParameters: OrganizationsApiAddOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiOrganizationDTO>>;
|
|
109
109
|
/**
|
|
110
110
|
* Use this method to add a new organization. Permissions required: Edit IQ Elements
|
|
111
111
|
*/
|
|
112
|
-
addOrganization(requestParameters?:
|
|
112
|
+
addOrganization(requestParameters?: OrganizationsApiAddOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiOrganizationDTO>;
|
|
113
113
|
/**
|
|
114
114
|
* Use this method to delete an existing organization, by providing the organization id. Permissions required: Edit IQ Elements
|
|
115
115
|
*/
|
|
116
|
-
deleteOrganizationRaw(requestParameters:
|
|
116
|
+
deleteOrganizationRaw(requestParameters: OrganizationsApiDeleteOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
117
117
|
/**
|
|
118
118
|
* Use this method to delete an existing organization, by providing the organization id. Permissions required: Edit IQ Elements
|
|
119
119
|
*/
|
|
120
|
-
deleteOrganization(requestParameters:
|
|
120
|
+
deleteOrganization(requestParameters: OrganizationsApiDeleteOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
121
121
|
/**
|
|
122
122
|
* Use this method to retrieve the details of an organization by providing the organization id. Permissions required: View IQ Elements
|
|
123
123
|
*/
|
|
124
|
-
getOrganizationRaw(requestParameters:
|
|
124
|
+
getOrganizationRaw(requestParameters: OrganizationsApiGetOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiOrganizationDTO>>;
|
|
125
125
|
/**
|
|
126
126
|
* Use this method to retrieve the details of an organization by providing the organization id. Permissions required: View IQ Elements
|
|
127
127
|
*/
|
|
128
|
-
getOrganization(requestParameters:
|
|
128
|
+
getOrganization(requestParameters: OrganizationsApiGetOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiOrganizationDTO>;
|
|
129
129
|
/**
|
|
130
130
|
* Use this method to retrieve organizations with names matching those specified or all if not specified. Permissions required: View IQ Elements
|
|
131
131
|
*/
|
|
132
|
-
getOrganizationsRaw(requestParameters:
|
|
132
|
+
getOrganizationsRaw(requestParameters: OrganizationsApiGetOrganizationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiOrganizationListDTO>>;
|
|
133
133
|
/**
|
|
134
134
|
* Use this method to retrieve organizations with names matching those specified or all if not specified. Permissions required: View IQ Elements
|
|
135
135
|
*/
|
|
136
|
-
getOrganizations(requestParameters?:
|
|
136
|
+
getOrganizations(requestParameters?: OrganizationsApiGetOrganizationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiOrganizationListDTO>;
|
|
137
137
|
/**
|
|
138
138
|
* Use this method to change the parent organization. Permissions required: Edit IQ Elements
|
|
139
139
|
*/
|
|
140
|
-
moveOrganizationRaw(requestParameters:
|
|
140
|
+
moveOrganizationRaw(requestParameters: OrganizationsApiMoveOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
141
141
|
/**
|
|
142
142
|
* Use this method to change the parent organization. Permissions required: Edit IQ Elements
|
|
143
143
|
*/
|
|
144
|
-
moveOrganization(requestParameters:
|
|
144
|
+
moveOrganization(requestParameters: OrganizationsApiMoveOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
145
145
|
}
|
|
@@ -11,23 +11,23 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import type { ApiApplicationEvaluationResultDTOV2, ApiApplicationEvaluationStatusDTOV2, ApiComponentEvaluationRequestDTOV2, ApiComponentEvaluationResultDTOV2, ApiComponentEvaluationTicketDTOV2, ApiPromoteScanRequestDTOV2, ApiSourceControlEvaluationRequestDTO } from '../models/index';
|
|
14
|
-
export interface
|
|
14
|
+
export interface PolicyEvaluationApiEvaluateComponentsRequest {
|
|
15
15
|
applicationId: string;
|
|
16
16
|
apiComponentEvaluationRequestDTOV2?: ApiComponentEvaluationRequestDTOV2;
|
|
17
17
|
}
|
|
18
|
-
export interface
|
|
18
|
+
export interface PolicyEvaluationApiEvaluateSourceControlRequest {
|
|
19
19
|
applicationId: string;
|
|
20
20
|
apiSourceControlEvaluationRequestDTO?: ApiSourceControlEvaluationRequestDTO;
|
|
21
21
|
}
|
|
22
|
-
export interface
|
|
22
|
+
export interface PolicyEvaluationApiGetApplicationEvaluationStatusRequest {
|
|
23
23
|
applicationId: string;
|
|
24
24
|
statusId: string;
|
|
25
25
|
}
|
|
26
|
-
export interface
|
|
26
|
+
export interface PolicyEvaluationApiGetComponentEvaluationRequest {
|
|
27
27
|
applicationId: string;
|
|
28
28
|
resultId: string;
|
|
29
29
|
}
|
|
30
|
-
export interface
|
|
30
|
+
export interface PolicyEvaluationApiPromoteScanRequest {
|
|
31
31
|
applicationId: string;
|
|
32
32
|
apiPromoteScanRequestDTOV2?: ApiPromoteScanRequestDTOV2;
|
|
33
33
|
}
|
|
@@ -46,11 +46,11 @@ export interface PolicyEvaluationApiInterface {
|
|
|
46
46
|
* @throws {RequiredError}
|
|
47
47
|
* @memberof PolicyEvaluationApiInterface
|
|
48
48
|
*/
|
|
49
|
-
evaluateComponentsRaw(requestParameters:
|
|
49
|
+
evaluateComponentsRaw(requestParameters: PolicyEvaluationApiEvaluateComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentEvaluationTicketDTOV2>>;
|
|
50
50
|
/**
|
|
51
51
|
* Use this method to request a component evaluation. This is step 1 of the 2 step policy evaluation for components process. Permissions Required: Evaluate Components
|
|
52
52
|
*/
|
|
53
|
-
evaluateComponents(requestParameters:
|
|
53
|
+
evaluateComponents(requestParameters: PolicyEvaluationApiEvaluateComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentEvaluationTicketDTOV2>;
|
|
54
54
|
/**
|
|
55
55
|
* Use this method to request a source control evaluation for a specific application. This is step 1 of the 2 step source control evaluation process. Permissions Required: Evaluate Applications
|
|
56
56
|
* @param {string} applicationId Enter the internal applicationId. Use the Applications REST API to retrieve the internal applicationId.
|
|
@@ -59,11 +59,11 @@ export interface PolicyEvaluationApiInterface {
|
|
|
59
59
|
* @throws {RequiredError}
|
|
60
60
|
* @memberof PolicyEvaluationApiInterface
|
|
61
61
|
*/
|
|
62
|
-
evaluateSourceControlRaw(requestParameters:
|
|
62
|
+
evaluateSourceControlRaw(requestParameters: PolicyEvaluationApiEvaluateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationStatusDTOV2>>;
|
|
63
63
|
/**
|
|
64
64
|
* Use this method to request a source control evaluation for a specific application. This is step 1 of the 2 step source control evaluation process. Permissions Required: Evaluate Applications
|
|
65
65
|
*/
|
|
66
|
-
evaluateSourceControl(requestParameters:
|
|
66
|
+
evaluateSourceControl(requestParameters: PolicyEvaluationApiEvaluateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationStatusDTOV2>;
|
|
67
67
|
/**
|
|
68
68
|
* This is step 2 of the policy evaluation process. Use the statusUrl obtained from the POST response for the corresponding applicationId. Permissions Required: Evaluate Applications
|
|
69
69
|
* @param {string} applicationId Enter the applicationId, for the which policy evaluation was requested.
|
|
@@ -72,11 +72,11 @@ export interface PolicyEvaluationApiInterface {
|
|
|
72
72
|
* @throws {RequiredError}
|
|
73
73
|
* @memberof PolicyEvaluationApiInterface
|
|
74
74
|
*/
|
|
75
|
-
getApplicationEvaluationStatusRaw(requestParameters:
|
|
75
|
+
getApplicationEvaluationStatusRaw(requestParameters: PolicyEvaluationApiGetApplicationEvaluationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationResultDTOV2>>;
|
|
76
76
|
/**
|
|
77
77
|
* This is step 2 of the policy evaluation process. Use the statusUrl obtained from the POST response for the corresponding applicationId. Permissions Required: Evaluate Applications
|
|
78
78
|
*/
|
|
79
|
-
getApplicationEvaluationStatus(requestParameters:
|
|
79
|
+
getApplicationEvaluationStatus(requestParameters: PolicyEvaluationApiGetApplicationEvaluationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationResultDTOV2>;
|
|
80
80
|
/**
|
|
81
81
|
* This is step 2 of the policy evaluation process for components. Use the resultId obtained from the POST response for the corresponding applicationId. Permissions Required: Evaluate Components
|
|
82
82
|
* @param {string} applicationId Enter the internal applicationId (same as that sent in the POST request (step 1))
|
|
@@ -85,11 +85,11 @@ export interface PolicyEvaluationApiInterface {
|
|
|
85
85
|
* @throws {RequiredError}
|
|
86
86
|
* @memberof PolicyEvaluationApiInterface
|
|
87
87
|
*/
|
|
88
|
-
getComponentEvaluationRaw(requestParameters:
|
|
88
|
+
getComponentEvaluationRaw(requestParameters: PolicyEvaluationApiGetComponentEvaluationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentEvaluationResultDTOV2>>;
|
|
89
89
|
/**
|
|
90
90
|
* This is step 2 of the policy evaluation process for components. Use the resultId obtained from the POST response for the corresponding applicationId. Permissions Required: Evaluate Components
|
|
91
91
|
*/
|
|
92
|
-
getComponentEvaluation(requestParameters:
|
|
92
|
+
getComponentEvaluation(requestParameters: PolicyEvaluationApiGetComponentEvaluationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentEvaluationResultDTOV2>;
|
|
93
93
|
/**
|
|
94
94
|
* Use this method to rescan older scans. This is done when the binaries of a previous build are now moving to a new stage in the production pipeline. Using this method, you can avoid rebuilding the application and reuse the scan metadata at the newer stage. This new evaluation will evaluate the most recent security and license data against your current policies. Permissions Required: Evaluate Applications
|
|
95
95
|
* @param {string} applicationId Enter the internal applicationId. Use the Applications REST API to retrieve the internal applicationId.
|
|
@@ -98,11 +98,11 @@ export interface PolicyEvaluationApiInterface {
|
|
|
98
98
|
* @throws {RequiredError}
|
|
99
99
|
* @memberof PolicyEvaluationApiInterface
|
|
100
100
|
*/
|
|
101
|
-
promoteScanRaw(requestParameters:
|
|
101
|
+
promoteScanRaw(requestParameters: PolicyEvaluationApiPromoteScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationStatusDTOV2>>;
|
|
102
102
|
/**
|
|
103
103
|
* Use this method to rescan older scans. This is done when the binaries of a previous build are now moving to a new stage in the production pipeline. Using this method, you can avoid rebuilding the application and reuse the scan metadata at the newer stage. This new evaluation will evaluate the most recent security and license data against your current policies. Permissions Required: Evaluate Applications
|
|
104
104
|
*/
|
|
105
|
-
promoteScan(requestParameters:
|
|
105
|
+
promoteScan(requestParameters: PolicyEvaluationApiPromoteScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationStatusDTOV2>;
|
|
106
106
|
}
|
|
107
107
|
/**
|
|
108
108
|
*
|
|
@@ -111,41 +111,41 @@ export declare class PolicyEvaluationApi extends runtime.BaseAPI implements Poli
|
|
|
111
111
|
/**
|
|
112
112
|
* Use this method to request a component evaluation. This is step 1 of the 2 step policy evaluation for components process. Permissions Required: Evaluate Components
|
|
113
113
|
*/
|
|
114
|
-
evaluateComponentsRaw(requestParameters:
|
|
114
|
+
evaluateComponentsRaw(requestParameters: PolicyEvaluationApiEvaluateComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentEvaluationTicketDTOV2>>;
|
|
115
115
|
/**
|
|
116
116
|
* Use this method to request a component evaluation. This is step 1 of the 2 step policy evaluation for components process. Permissions Required: Evaluate Components
|
|
117
117
|
*/
|
|
118
|
-
evaluateComponents(requestParameters:
|
|
118
|
+
evaluateComponents(requestParameters: PolicyEvaluationApiEvaluateComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentEvaluationTicketDTOV2>;
|
|
119
119
|
/**
|
|
120
120
|
* Use this method to request a source control evaluation for a specific application. This is step 1 of the 2 step source control evaluation process. Permissions Required: Evaluate Applications
|
|
121
121
|
*/
|
|
122
|
-
evaluateSourceControlRaw(requestParameters:
|
|
122
|
+
evaluateSourceControlRaw(requestParameters: PolicyEvaluationApiEvaluateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationStatusDTOV2>>;
|
|
123
123
|
/**
|
|
124
124
|
* Use this method to request a source control evaluation for a specific application. This is step 1 of the 2 step source control evaluation process. Permissions Required: Evaluate Applications
|
|
125
125
|
*/
|
|
126
|
-
evaluateSourceControl(requestParameters:
|
|
126
|
+
evaluateSourceControl(requestParameters: PolicyEvaluationApiEvaluateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationStatusDTOV2>;
|
|
127
127
|
/**
|
|
128
128
|
* This is step 2 of the policy evaluation process. Use the statusUrl obtained from the POST response for the corresponding applicationId. Permissions Required: Evaluate Applications
|
|
129
129
|
*/
|
|
130
|
-
getApplicationEvaluationStatusRaw(requestParameters:
|
|
130
|
+
getApplicationEvaluationStatusRaw(requestParameters: PolicyEvaluationApiGetApplicationEvaluationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationResultDTOV2>>;
|
|
131
131
|
/**
|
|
132
132
|
* This is step 2 of the policy evaluation process. Use the statusUrl obtained from the POST response for the corresponding applicationId. Permissions Required: Evaluate Applications
|
|
133
133
|
*/
|
|
134
|
-
getApplicationEvaluationStatus(requestParameters:
|
|
134
|
+
getApplicationEvaluationStatus(requestParameters: PolicyEvaluationApiGetApplicationEvaluationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationResultDTOV2>;
|
|
135
135
|
/**
|
|
136
136
|
* This is step 2 of the policy evaluation process for components. Use the resultId obtained from the POST response for the corresponding applicationId. Permissions Required: Evaluate Components
|
|
137
137
|
*/
|
|
138
|
-
getComponentEvaluationRaw(requestParameters:
|
|
138
|
+
getComponentEvaluationRaw(requestParameters: PolicyEvaluationApiGetComponentEvaluationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentEvaluationResultDTOV2>>;
|
|
139
139
|
/**
|
|
140
140
|
* This is step 2 of the policy evaluation process for components. Use the resultId obtained from the POST response for the corresponding applicationId. Permissions Required: Evaluate Components
|
|
141
141
|
*/
|
|
142
|
-
getComponentEvaluation(requestParameters:
|
|
142
|
+
getComponentEvaluation(requestParameters: PolicyEvaluationApiGetComponentEvaluationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentEvaluationResultDTOV2>;
|
|
143
143
|
/**
|
|
144
144
|
* Use this method to rescan older scans. This is done when the binaries of a previous build are now moving to a new stage in the production pipeline. Using this method, you can avoid rebuilding the application and reuse the scan metadata at the newer stage. This new evaluation will evaluate the most recent security and license data against your current policies. Permissions Required: Evaluate Applications
|
|
145
145
|
*/
|
|
146
|
-
promoteScanRaw(requestParameters:
|
|
146
|
+
promoteScanRaw(requestParameters: PolicyEvaluationApiPromoteScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationStatusDTOV2>>;
|
|
147
147
|
/**
|
|
148
148
|
* Use this method to rescan older scans. This is done when the binaries of a previous build are now moving to a new stage in the production pipeline. Using this method, you can avoid rebuilding the application and reuse the scan metadata at the newer stage. This new evaluation will evaluate the most recent security and license data against your current policies. Permissions Required: Evaluate Applications
|
|
149
149
|
*/
|
|
150
|
-
promoteScan(requestParameters:
|
|
150
|
+
promoteScan(requestParameters: PolicyEvaluationApiPromoteScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationStatusDTOV2>;
|
|
151
151
|
}
|
|
@@ -11,31 +11,31 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import type { ApiApplicationViolationListDTOV2, ApiAutoPolicyWaiverDTO, ApiComponentTransitivePolicyViolationsDTO, ApiCrossStageViolationDTOV2, ApiPolicyWaiverDTO, ApiPolicyWaiverRequestsApplicableToViolationDTO, ApiPolicyWaiversApplicableToViolationDTO, ComponentIdentifier } from '../models/index';
|
|
14
|
-
export interface
|
|
14
|
+
export interface PolicyViolationDetailsApiGetApplicableAutoWaiverRequest {
|
|
15
15
|
violationId: string;
|
|
16
16
|
}
|
|
17
|
-
export interface
|
|
17
|
+
export interface PolicyViolationDetailsApiGetApplicableWaiverRequestsRequest {
|
|
18
18
|
violationId: string;
|
|
19
19
|
}
|
|
20
|
-
export interface
|
|
20
|
+
export interface PolicyViolationDetailsApiGetApplicableWaiversRequest {
|
|
21
21
|
violationId: string;
|
|
22
22
|
}
|
|
23
|
-
export interface
|
|
23
|
+
export interface PolicyViolationDetailsApiGetCrossStagePolicyViolationByConstituentIdRequest {
|
|
24
24
|
constituentId: string;
|
|
25
25
|
}
|
|
26
|
-
export interface
|
|
26
|
+
export interface PolicyViolationDetailsApiGetCrossStagePolicyViolationByIdRequest {
|
|
27
27
|
violationId: string;
|
|
28
28
|
}
|
|
29
|
-
export interface
|
|
29
|
+
export interface PolicyViolationDetailsApiGetPolicyViolationsRequest {
|
|
30
30
|
p: Set<string>;
|
|
31
31
|
openTimeAfter?: string;
|
|
32
32
|
openTimeBefore?: string;
|
|
33
33
|
type?: Set<GetPolicyViolationsTypeEnum>;
|
|
34
34
|
}
|
|
35
|
-
export interface
|
|
35
|
+
export interface PolicyViolationDetailsApiGetSimilarWaiversRequest {
|
|
36
36
|
violationId: string;
|
|
37
37
|
}
|
|
38
|
-
export interface
|
|
38
|
+
export interface PolicyViolationDetailsApiGetTransitivePolicyViolationsByAppScanComponentRequest {
|
|
39
39
|
ownerType: GetTransitivePolicyViolationsByAppScanComponentOwnerTypeEnum;
|
|
40
40
|
ownerId: string;
|
|
41
41
|
scanId: string;
|
|
@@ -43,7 +43,7 @@ export interface GetTransitivePolicyViolationsByAppScanComponentRequest {
|
|
|
43
43
|
packageUrl?: string;
|
|
44
44
|
hash?: string;
|
|
45
45
|
}
|
|
46
|
-
export interface
|
|
46
|
+
export interface PolicyViolationDetailsApiGetTransitivePolicyViolationsByOwnerStageComponentRequest {
|
|
47
47
|
ownerType: GetTransitivePolicyViolationsByOwnerStageComponentOwnerTypeEnum;
|
|
48
48
|
ownerId: string;
|
|
49
49
|
stageId: string;
|
|
@@ -65,11 +65,11 @@ export interface PolicyViolationDetailsApiInterface {
|
|
|
65
65
|
* @throws {RequiredError}
|
|
66
66
|
* @memberof PolicyViolationDetailsApiInterface
|
|
67
67
|
*/
|
|
68
|
-
getApplicableAutoWaiverRaw(requestParameters:
|
|
68
|
+
getApplicableAutoWaiverRaw(requestParameters: PolicyViolationDetailsApiGetApplicableAutoWaiverRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiAutoPolicyWaiverDTO>>;
|
|
69
69
|
/**
|
|
70
70
|
* Use this method to obtain the existing auto waiver applicable to a policy violationviolation. Permissions required: View IQ Elements
|
|
71
71
|
*/
|
|
72
|
-
getApplicableAutoWaiver(requestParameters:
|
|
72
|
+
getApplicableAutoWaiver(requestParameters: PolicyViolationDetailsApiGetApplicableAutoWaiverRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiAutoPolicyWaiverDTO>;
|
|
73
73
|
/**
|
|
74
74
|
* Use this method to obtain all existing waiver requests that are applicable to a policy violation. A waiver request is considered as \'applicable\' if it matches the following conditions:<ul><li>The policyId for the policy violation matches the policyId associated with the waiver request</li><li>The violated policy conditions match the policy conditions of the waiver request/li><li>The waiver request scope matches the violating component</li></ul> Permissions required: View IQ Elements
|
|
75
75
|
* @param {string} violationId Enter the policy violationId for which you want to obtain the applicable waiver requests.
|
|
@@ -77,11 +77,11 @@ export interface PolicyViolationDetailsApiInterface {
|
|
|
77
77
|
* @throws {RequiredError}
|
|
78
78
|
* @memberof PolicyViolationDetailsApiInterface
|
|
79
79
|
*/
|
|
80
|
-
getApplicableWaiverRequestsRaw(requestParameters:
|
|
80
|
+
getApplicableWaiverRequestsRaw(requestParameters: PolicyViolationDetailsApiGetApplicableWaiverRequestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiPolicyWaiverRequestsApplicableToViolationDTO>>;
|
|
81
81
|
/**
|
|
82
82
|
* Use this method to obtain all existing waiver requests that are applicable to a policy violation. A waiver request is considered as \'applicable\' if it matches the following conditions:<ul><li>The policyId for the policy violation matches the policyId associated with the waiver request</li><li>The violated policy conditions match the policy conditions of the waiver request/li><li>The waiver request scope matches the violating component</li></ul> Permissions required: View IQ Elements
|
|
83
83
|
*/
|
|
84
|
-
getApplicableWaiverRequests(requestParameters:
|
|
84
|
+
getApplicableWaiverRequests(requestParameters: PolicyViolationDetailsApiGetApplicableWaiverRequestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiPolicyWaiverRequestsApplicableToViolationDTO>;
|
|
85
85
|
/**
|
|
86
86
|
* Use this method to obtain all existing waivers that are applicable to a policy violation. A waiver is considered as \'applicable\' if it matches the following conditions:<ul><li>The policyId for the policy violation matches the policyId associated with the waiver</li><li>The violated policy conditions match the policy conditions of the waiver/li><li>The waiver scope matches the violating component</li></ul> Permissions required: View IQ Elements
|
|
87
87
|
* @param {string} violationId Enter the policy violationId for which you want to obtain the applicable waivers.
|
|
@@ -89,11 +89,11 @@ export interface PolicyViolationDetailsApiInterface {
|
|
|
89
89
|
* @throws {RequiredError}
|
|
90
90
|
* @memberof PolicyViolationDetailsApiInterface
|
|
91
91
|
*/
|
|
92
|
-
getApplicableWaiversRaw(requestParameters:
|
|
92
|
+
getApplicableWaiversRaw(requestParameters: PolicyViolationDetailsApiGetApplicableWaiversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiPolicyWaiversApplicableToViolationDTO>>;
|
|
93
93
|
/**
|
|
94
94
|
* Use this method to obtain all existing waivers that are applicable to a policy violation. A waiver is considered as \'applicable\' if it matches the following conditions:<ul><li>The policyId for the policy violation matches the policyId associated with the waiver</li><li>The violated policy conditions match the policy conditions of the waiver/li><li>The waiver scope matches the violating component</li></ul> Permissions required: View IQ Elements
|
|
95
95
|
*/
|
|
96
|
-
getApplicableWaivers(requestParameters:
|
|
96
|
+
getApplicableWaivers(requestParameters: PolicyViolationDetailsApiGetApplicableWaiversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiPolicyWaiversApplicableToViolationDTO>;
|
|
97
97
|
/**
|
|
98
98
|
* A cross-stage policy violation represents an aggregate of all violations of a policy occurring across multiple stages of an application. Cross-stage policy violations are helpful in performance analysis by determining the time taken to remediate a violation across all stages where it was detected. Use this method to retrieve all cross-stage violations, irrespective of the time they were detected. Permissions required: View IQ Elements
|
|
99
99
|
* @param {string} constituentId Enter the violationId. Use the GET method described for the endpoint /api/v2/policyViolations to obtain the policy violationId.
|
|
@@ -101,11 +101,11 @@ export interface PolicyViolationDetailsApiInterface {
|
|
|
101
101
|
* @throws {RequiredError}
|
|
102
102
|
* @memberof PolicyViolationDetailsApiInterface
|
|
103
103
|
*/
|
|
104
|
-
getCrossStagePolicyViolationByConstituentIdRaw(requestParameters:
|
|
104
|
+
getCrossStagePolicyViolationByConstituentIdRaw(requestParameters: PolicyViolationDetailsApiGetCrossStagePolicyViolationByConstituentIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiCrossStageViolationDTOV2>>;
|
|
105
105
|
/**
|
|
106
106
|
* A cross-stage policy violation represents an aggregate of all violations of a policy occurring across multiple stages of an application. Cross-stage policy violations are helpful in performance analysis by determining the time taken to remediate a violation across all stages where it was detected. Use this method to retrieve all cross-stage violations, irrespective of the time they were detected. Permissions required: View IQ Elements
|
|
107
107
|
*/
|
|
108
|
-
getCrossStagePolicyViolationByConstituentId(requestParameters:
|
|
108
|
+
getCrossStagePolicyViolationByConstituentId(requestParameters: PolicyViolationDetailsApiGetCrossStagePolicyViolationByConstituentIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiCrossStageViolationDTOV2>;
|
|
109
109
|
/**
|
|
110
110
|
* A cross-stage policy violation represents an aggregate of all violations of the same policy, occurring at multiple stages for an application. Cross-stage policy violations are helpful in performance analysis by determining the time taken to remediate a violation across all stages where it was detected. Use this method to retrieve cross-stage policy violations. Permissions required: View IQ Elements
|
|
111
111
|
* @param {string} violationId Enter the policy `violationId`. Use the GET method described for the endpoint /api/v2/policyViolations to obtain the policy violationId.
|
|
@@ -113,11 +113,11 @@ export interface PolicyViolationDetailsApiInterface {
|
|
|
113
113
|
* @throws {RequiredError}
|
|
114
114
|
* @memberof PolicyViolationDetailsApiInterface
|
|
115
115
|
*/
|
|
116
|
-
getCrossStagePolicyViolationByIdRaw(requestParameters:
|
|
116
|
+
getCrossStagePolicyViolationByIdRaw(requestParameters: PolicyViolationDetailsApiGetCrossStagePolicyViolationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiCrossStageViolationDTOV2>>;
|
|
117
117
|
/**
|
|
118
118
|
* A cross-stage policy violation represents an aggregate of all violations of the same policy, occurring at multiple stages for an application. Cross-stage policy violations are helpful in performance analysis by determining the time taken to remediate a violation across all stages where it was detected. Use this method to retrieve cross-stage policy violations. Permissions required: View IQ Elements
|
|
119
119
|
*/
|
|
120
|
-
getCrossStagePolicyViolationById(requestParameters:
|
|
120
|
+
getCrossStagePolicyViolationById(requestParameters: PolicyViolationDetailsApiGetCrossStagePolicyViolationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiCrossStageViolationDTOV2>;
|
|
121
121
|
/**
|
|
122
122
|
* Use this method to retrieve policy violation details for a policy/policies. You will need the policyId(s) to retrieve the policy violations details. policyId is available as the response field of the Policies REST API. Permissions required: View IQ Elements
|
|
123
123
|
* @param {Set<string>} p Enter the policyIds to obtain the corresponding violation details
|
|
@@ -128,11 +128,11 @@ export interface PolicyViolationDetailsApiInterface {
|
|
|
128
128
|
* @throws {RequiredError}
|
|
129
129
|
* @memberof PolicyViolationDetailsApiInterface
|
|
130
130
|
*/
|
|
131
|
-
getPolicyViolationsRaw(requestParameters:
|
|
131
|
+
getPolicyViolationsRaw(requestParameters: PolicyViolationDetailsApiGetPolicyViolationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationViolationListDTOV2>>;
|
|
132
132
|
/**
|
|
133
133
|
* Use this method to retrieve policy violation details for a policy/policies. You will need the policyId(s) to retrieve the policy violations details. policyId is available as the response field of the Policies REST API. Permissions required: View IQ Elements
|
|
134
134
|
*/
|
|
135
|
-
getPolicyViolations(requestParameters:
|
|
135
|
+
getPolicyViolations(requestParameters: PolicyViolationDetailsApiGetPolicyViolationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationViolationListDTOV2>;
|
|
136
136
|
/**
|
|
137
137
|
*
|
|
138
138
|
* @param {string} violationId
|
|
@@ -140,10 +140,10 @@ export interface PolicyViolationDetailsApiInterface {
|
|
|
140
140
|
* @throws {RequiredError}
|
|
141
141
|
* @memberof PolicyViolationDetailsApiInterface
|
|
142
142
|
*/
|
|
143
|
-
getSimilarWaiversRaw(requestParameters:
|
|
143
|
+
getSimilarWaiversRaw(requestParameters: PolicyViolationDetailsApiGetSimilarWaiversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiPolicyWaiverDTO>>>;
|
|
144
144
|
/**
|
|
145
145
|
*/
|
|
146
|
-
getSimilarWaivers(requestParameters:
|
|
146
|
+
getSimilarWaivers(requestParameters: PolicyViolationDetailsApiGetSimilarWaiversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiPolicyWaiverDTO>>;
|
|
147
147
|
/**
|
|
148
148
|
* Use this method to retrieve transitive policy violations for a given component in a specific scan. Permissions required: View IQ Elements
|
|
149
149
|
* @param {'application'} ownerType Enter the scope for this violation. Possible values are \'application\'
|
|
@@ -156,11 +156,11 @@ export interface PolicyViolationDetailsApiInterface {
|
|
|
156
156
|
* @throws {RequiredError}
|
|
157
157
|
* @memberof PolicyViolationDetailsApiInterface
|
|
158
158
|
*/
|
|
159
|
-
getTransitivePolicyViolationsByAppScanComponentRaw(requestParameters:
|
|
159
|
+
getTransitivePolicyViolationsByAppScanComponentRaw(requestParameters: PolicyViolationDetailsApiGetTransitivePolicyViolationsByAppScanComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentTransitivePolicyViolationsDTO>>;
|
|
160
160
|
/**
|
|
161
161
|
* Use this method to retrieve transitive policy violations for a given component in a specific scan. Permissions required: View IQ Elements
|
|
162
162
|
*/
|
|
163
|
-
getTransitivePolicyViolationsByAppScanComponent(requestParameters:
|
|
163
|
+
getTransitivePolicyViolationsByAppScanComponent(requestParameters: PolicyViolationDetailsApiGetTransitivePolicyViolationsByAppScanComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentTransitivePolicyViolationsDTO>;
|
|
164
164
|
/**
|
|
165
165
|
* Use this method to obtain all transitive policy violations for a given component in a specific stage. Transitive policy violations are violations caused by transitive dependencies. Permissions required: View IQ Elements
|
|
166
166
|
* @param {'application' | 'organization'} ownerType Possible values are \'application\' or \'organization\'
|
|
@@ -173,11 +173,11 @@ export interface PolicyViolationDetailsApiInterface {
|
|
|
173
173
|
* @throws {RequiredError}
|
|
174
174
|
* @memberof PolicyViolationDetailsApiInterface
|
|
175
175
|
*/
|
|
176
|
-
getTransitivePolicyViolationsByOwnerStageComponentRaw(requestParameters:
|
|
176
|
+
getTransitivePolicyViolationsByOwnerStageComponentRaw(requestParameters: PolicyViolationDetailsApiGetTransitivePolicyViolationsByOwnerStageComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentTransitivePolicyViolationsDTO>>;
|
|
177
177
|
/**
|
|
178
178
|
* Use this method to obtain all transitive policy violations for a given component in a specific stage. Transitive policy violations are violations caused by transitive dependencies. Permissions required: View IQ Elements
|
|
179
179
|
*/
|
|
180
|
-
getTransitivePolicyViolationsByOwnerStageComponent(requestParameters:
|
|
180
|
+
getTransitivePolicyViolationsByOwnerStageComponent(requestParameters: PolicyViolationDetailsApiGetTransitivePolicyViolationsByOwnerStageComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentTransitivePolicyViolationsDTO>;
|
|
181
181
|
}
|
|
182
182
|
/**
|
|
183
183
|
*
|
|
@@ -186,73 +186,73 @@ export declare class PolicyViolationDetailsApi extends runtime.BaseAPI implement
|
|
|
186
186
|
/**
|
|
187
187
|
* Use this method to obtain the existing auto waiver applicable to a policy violationviolation. Permissions required: View IQ Elements
|
|
188
188
|
*/
|
|
189
|
-
getApplicableAutoWaiverRaw(requestParameters:
|
|
189
|
+
getApplicableAutoWaiverRaw(requestParameters: PolicyViolationDetailsApiGetApplicableAutoWaiverRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiAutoPolicyWaiverDTO>>;
|
|
190
190
|
/**
|
|
191
191
|
* Use this method to obtain the existing auto waiver applicable to a policy violationviolation. Permissions required: View IQ Elements
|
|
192
192
|
*/
|
|
193
|
-
getApplicableAutoWaiver(requestParameters:
|
|
193
|
+
getApplicableAutoWaiver(requestParameters: PolicyViolationDetailsApiGetApplicableAutoWaiverRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiAutoPolicyWaiverDTO>;
|
|
194
194
|
/**
|
|
195
195
|
* Use this method to obtain all existing waiver requests that are applicable to a policy violation. A waiver request is considered as \'applicable\' if it matches the following conditions:<ul><li>The policyId for the policy violation matches the policyId associated with the waiver request</li><li>The violated policy conditions match the policy conditions of the waiver request/li><li>The waiver request scope matches the violating component</li></ul> Permissions required: View IQ Elements
|
|
196
196
|
*/
|
|
197
|
-
getApplicableWaiverRequestsRaw(requestParameters:
|
|
197
|
+
getApplicableWaiverRequestsRaw(requestParameters: PolicyViolationDetailsApiGetApplicableWaiverRequestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiPolicyWaiverRequestsApplicableToViolationDTO>>;
|
|
198
198
|
/**
|
|
199
199
|
* Use this method to obtain all existing waiver requests that are applicable to a policy violation. A waiver request is considered as \'applicable\' if it matches the following conditions:<ul><li>The policyId for the policy violation matches the policyId associated with the waiver request</li><li>The violated policy conditions match the policy conditions of the waiver request/li><li>The waiver request scope matches the violating component</li></ul> Permissions required: View IQ Elements
|
|
200
200
|
*/
|
|
201
|
-
getApplicableWaiverRequests(requestParameters:
|
|
201
|
+
getApplicableWaiverRequests(requestParameters: PolicyViolationDetailsApiGetApplicableWaiverRequestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiPolicyWaiverRequestsApplicableToViolationDTO>;
|
|
202
202
|
/**
|
|
203
203
|
* Use this method to obtain all existing waivers that are applicable to a policy violation. A waiver is considered as \'applicable\' if it matches the following conditions:<ul><li>The policyId for the policy violation matches the policyId associated with the waiver</li><li>The violated policy conditions match the policy conditions of the waiver/li><li>The waiver scope matches the violating component</li></ul> Permissions required: View IQ Elements
|
|
204
204
|
*/
|
|
205
|
-
getApplicableWaiversRaw(requestParameters:
|
|
205
|
+
getApplicableWaiversRaw(requestParameters: PolicyViolationDetailsApiGetApplicableWaiversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiPolicyWaiversApplicableToViolationDTO>>;
|
|
206
206
|
/**
|
|
207
207
|
* Use this method to obtain all existing waivers that are applicable to a policy violation. A waiver is considered as \'applicable\' if it matches the following conditions:<ul><li>The policyId for the policy violation matches the policyId associated with the waiver</li><li>The violated policy conditions match the policy conditions of the waiver/li><li>The waiver scope matches the violating component</li></ul> Permissions required: View IQ Elements
|
|
208
208
|
*/
|
|
209
|
-
getApplicableWaivers(requestParameters:
|
|
209
|
+
getApplicableWaivers(requestParameters: PolicyViolationDetailsApiGetApplicableWaiversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiPolicyWaiversApplicableToViolationDTO>;
|
|
210
210
|
/**
|
|
211
211
|
* A cross-stage policy violation represents an aggregate of all violations of a policy occurring across multiple stages of an application. Cross-stage policy violations are helpful in performance analysis by determining the time taken to remediate a violation across all stages where it was detected. Use this method to retrieve all cross-stage violations, irrespective of the time they were detected. Permissions required: View IQ Elements
|
|
212
212
|
*/
|
|
213
|
-
getCrossStagePolicyViolationByConstituentIdRaw(requestParameters:
|
|
213
|
+
getCrossStagePolicyViolationByConstituentIdRaw(requestParameters: PolicyViolationDetailsApiGetCrossStagePolicyViolationByConstituentIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiCrossStageViolationDTOV2>>;
|
|
214
214
|
/**
|
|
215
215
|
* A cross-stage policy violation represents an aggregate of all violations of a policy occurring across multiple stages of an application. Cross-stage policy violations are helpful in performance analysis by determining the time taken to remediate a violation across all stages where it was detected. Use this method to retrieve all cross-stage violations, irrespective of the time they were detected. Permissions required: View IQ Elements
|
|
216
216
|
*/
|
|
217
|
-
getCrossStagePolicyViolationByConstituentId(requestParameters:
|
|
217
|
+
getCrossStagePolicyViolationByConstituentId(requestParameters: PolicyViolationDetailsApiGetCrossStagePolicyViolationByConstituentIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiCrossStageViolationDTOV2>;
|
|
218
218
|
/**
|
|
219
219
|
* A cross-stage policy violation represents an aggregate of all violations of the same policy, occurring at multiple stages for an application. Cross-stage policy violations are helpful in performance analysis by determining the time taken to remediate a violation across all stages where it was detected. Use this method to retrieve cross-stage policy violations. Permissions required: View IQ Elements
|
|
220
220
|
*/
|
|
221
|
-
getCrossStagePolicyViolationByIdRaw(requestParameters:
|
|
221
|
+
getCrossStagePolicyViolationByIdRaw(requestParameters: PolicyViolationDetailsApiGetCrossStagePolicyViolationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiCrossStageViolationDTOV2>>;
|
|
222
222
|
/**
|
|
223
223
|
* A cross-stage policy violation represents an aggregate of all violations of the same policy, occurring at multiple stages for an application. Cross-stage policy violations are helpful in performance analysis by determining the time taken to remediate a violation across all stages where it was detected. Use this method to retrieve cross-stage policy violations. Permissions required: View IQ Elements
|
|
224
224
|
*/
|
|
225
|
-
getCrossStagePolicyViolationById(requestParameters:
|
|
225
|
+
getCrossStagePolicyViolationById(requestParameters: PolicyViolationDetailsApiGetCrossStagePolicyViolationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiCrossStageViolationDTOV2>;
|
|
226
226
|
/**
|
|
227
227
|
* Use this method to retrieve policy violation details for a policy/policies. You will need the policyId(s) to retrieve the policy violations details. policyId is available as the response field of the Policies REST API. Permissions required: View IQ Elements
|
|
228
228
|
*/
|
|
229
|
-
getPolicyViolationsRaw(requestParameters:
|
|
229
|
+
getPolicyViolationsRaw(requestParameters: PolicyViolationDetailsApiGetPolicyViolationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationViolationListDTOV2>>;
|
|
230
230
|
/**
|
|
231
231
|
* Use this method to retrieve policy violation details for a policy/policies. You will need the policyId(s) to retrieve the policy violations details. policyId is available as the response field of the Policies REST API. Permissions required: View IQ Elements
|
|
232
232
|
*/
|
|
233
|
-
getPolicyViolations(requestParameters:
|
|
233
|
+
getPolicyViolations(requestParameters: PolicyViolationDetailsApiGetPolicyViolationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationViolationListDTOV2>;
|
|
234
234
|
/**
|
|
235
235
|
*/
|
|
236
|
-
getSimilarWaiversRaw(requestParameters:
|
|
236
|
+
getSimilarWaiversRaw(requestParameters: PolicyViolationDetailsApiGetSimilarWaiversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiPolicyWaiverDTO>>>;
|
|
237
237
|
/**
|
|
238
238
|
*/
|
|
239
|
-
getSimilarWaivers(requestParameters:
|
|
239
|
+
getSimilarWaivers(requestParameters: PolicyViolationDetailsApiGetSimilarWaiversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiPolicyWaiverDTO>>;
|
|
240
240
|
/**
|
|
241
241
|
* Use this method to retrieve transitive policy violations for a given component in a specific scan. Permissions required: View IQ Elements
|
|
242
242
|
*/
|
|
243
|
-
getTransitivePolicyViolationsByAppScanComponentRaw(requestParameters:
|
|
243
|
+
getTransitivePolicyViolationsByAppScanComponentRaw(requestParameters: PolicyViolationDetailsApiGetTransitivePolicyViolationsByAppScanComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentTransitivePolicyViolationsDTO>>;
|
|
244
244
|
/**
|
|
245
245
|
* Use this method to retrieve transitive policy violations for a given component in a specific scan. Permissions required: View IQ Elements
|
|
246
246
|
*/
|
|
247
|
-
getTransitivePolicyViolationsByAppScanComponent(requestParameters:
|
|
247
|
+
getTransitivePolicyViolationsByAppScanComponent(requestParameters: PolicyViolationDetailsApiGetTransitivePolicyViolationsByAppScanComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentTransitivePolicyViolationsDTO>;
|
|
248
248
|
/**
|
|
249
249
|
* Use this method to obtain all transitive policy violations for a given component in a specific stage. Transitive policy violations are violations caused by transitive dependencies. Permissions required: View IQ Elements
|
|
250
250
|
*/
|
|
251
|
-
getTransitivePolicyViolationsByOwnerStageComponentRaw(requestParameters:
|
|
251
|
+
getTransitivePolicyViolationsByOwnerStageComponentRaw(requestParameters: PolicyViolationDetailsApiGetTransitivePolicyViolationsByOwnerStageComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentTransitivePolicyViolationsDTO>>;
|
|
252
252
|
/**
|
|
253
253
|
* Use this method to obtain all transitive policy violations for a given component in a specific stage. Transitive policy violations are violations caused by transitive dependencies. Permissions required: View IQ Elements
|
|
254
254
|
*/
|
|
255
|
-
getTransitivePolicyViolationsByOwnerStageComponent(requestParameters:
|
|
255
|
+
getTransitivePolicyViolationsByOwnerStageComponent(requestParameters: PolicyViolationDetailsApiGetTransitivePolicyViolationsByOwnerStageComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentTransitivePolicyViolationsDTO>;
|
|
256
256
|
}
|
|
257
257
|
/**
|
|
258
258
|
* @export
|