@maxim_mazurok/gapi.client.websecurityscanner-v1beta 0.1.20251207 → 0.2.20251207

package/index.d.ts

@@ -77,7 +77,12 @@ declare namespace gapi.client {
       /** The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */
       reproductionUrl?: string;
       /** The severity level of the reported vulnerability. */
-      severity?: string;
+      severity?:
+        | 'SEVERITY_UNSPECIFIED'
+        | 'CRITICAL'
+        | 'HIGH'
+        | 'MEDIUM'
+        | 'LOW';
       /** The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */
       trackingId?: string;
       /** An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */
@@ -167,7 +172,10 @@ declare namespace gapi.client {
       /** Required. The user provided display name of the ScanConfig. */
       displayName?: string;
       /** Controls export of scan configurations and results to Security Command Center. */
-      exportToSecurityCommandCenter?: string;
+      exportToSecurityCommandCenter?:
+        | 'EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED'
+        | 'ENABLED'
+        | 'DISABLED';
       /** Whether to keep scanning even if most requests return HTTP error codes. */
       ignoreHttpStatusErrors?: boolean;
       /** Latest ScanRun if available. */
@@ -179,7 +187,7 @@ declare namespace gapi.client {
       /** The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */
       name?: string;
       /** The risk level selected for the scan */
-      riskLevel?: string;
+      riskLevel?: 'RISK_LEVEL_UNSPECIFIED' | 'NORMAL' | 'LOW';
       /** The schedule of the ScanConfig. */
       schedule?: Schedule;
       /** Required. The starting URLs from which the scanner finds site pages. */
@@ -187,13 +195,65 @@ declare namespace gapi.client {
       /** Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. */
       staticIpScan?: boolean;
       /** Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. */
-      targetPlatforms?: string[];
+      targetPlatforms?:
+        | 'TARGET_PLATFORM_UNSPECIFIED'
+        | 'APP_ENGINE'
+        | 'COMPUTE'
+        | 'CLOUD_RUN'
+        | 'CLOUD_FUNCTIONS'[];
       /** The user agent used during scanning. */
-      userAgent?: string;
+      userAgent?:
+        | 'USER_AGENT_UNSPECIFIED'
+        | 'CHROME_LINUX'
+        | 'CHROME_ANDROID'
+        | 'SAFARI_IPHONE';
     }
     interface ScanConfigError {
       /** Indicates the reason code for a configuration failure. */
-      code?: string;
+      code?:
+        | 'CODE_UNSPECIFIED'
+        | 'OK'
+        | 'INTERNAL_ERROR'
+        | 'APPENGINE_API_BACKEND_ERROR'
+        | 'APPENGINE_API_NOT_ACCESSIBLE'
+        | 'APPENGINE_DEFAULT_HOST_MISSING'
+        | 'CANNOT_USE_GOOGLE_COM_ACCOUNT'
+        | 'CANNOT_USE_OWNER_ACCOUNT'
+        | 'COMPUTE_API_BACKEND_ERROR'
+        | 'COMPUTE_API_NOT_ACCESSIBLE'
+        | 'CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT'
+        | 'CUSTOM_LOGIN_URL_MALFORMED'
+        | 'CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS'
+        | 'CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS'
+        | 'CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS'
+        | 'CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS'
+        | 'DUPLICATE_SCAN_NAME'
+        | 'INVALID_FIELD_VALUE'
+        | 'FAILED_TO_AUTHENTICATE_TO_TARGET'
+        | 'FINDING_TYPE_UNSPECIFIED'
+        | 'FORBIDDEN_TO_SCAN_COMPUTE'
+        | 'FORBIDDEN_UPDATE_TO_MANAGED_SCAN'
+        | 'MALFORMED_FILTER'
+        | 'MALFORMED_RESOURCE_NAME'
+        | 'PROJECT_INACTIVE'
+        | 'REQUIRED_FIELD'
+        | 'RESOURCE_NAME_INCONSISTENT'
+        | 'SCAN_ALREADY_RUNNING'
+        | 'SCAN_NOT_RUNNING'
+        | 'SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT'
+        | 'SEED_URL_MALFORMED'
+        | 'SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS'
+        | 'SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS'
+        | 'SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS'
+        | 'SEED_URL_HAS_UNRESERVED_IP_ADDRESS'
+        | 'SERVICE_ACCOUNT_NOT_CONFIGURED'
+        | 'TOO_MANY_SCANS'
+        | 'UNABLE_TO_RESOLVE_PROJECT_INFO'
+        | 'UNSUPPORTED_BLACKLIST_PATTERN_FORMAT'
+        | 'UNSUPPORTED_FILTER'
+        | 'UNSUPPORTED_FINDING_TYPE'
+        | 'UNSUPPORTED_URL_SCHEME'
+        | 'CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND';
       /** Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future. */
       fieldName?: string;
     }
@@ -203,7 +263,11 @@ declare namespace gapi.client {
       /** If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. */
       errorTrace?: ScanRunErrorTrace;
       /** The execution state of the ScanRun. */
-      executionState?: string;
+      executionState?:
+        | 'EXECUTION_STATE_UNSPECIFIED'
+        | 'QUEUED'
+        | 'SCANNING'
+        | 'FINISHED';
       /** Whether the scan run has found any vulnerabilities. */
       hasVulnerabilities?: boolean;
       /** The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. */
@@ -211,7 +275,7 @@ declare namespace gapi.client {
       /** The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. */
       progressPercent?: number;
       /** The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". */
-      resultState?: string;
+      resultState?: 'RESULT_STATE_UNSPECIFIED' | 'SUCCESS' | 'ERROR' | 'KILLED';
       /** The time at which the ScanRun started. */
       startTime?: string;
       /** The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. */
@@ -223,7 +287,15 @@ declare namespace gapi.client {
     }
     interface ScanRunErrorTrace {
       /** Indicates the error reason code. */
-      code?: string;
+      code?:
+        | 'CODE_UNSPECIFIED'
+        | 'INTERNAL_ERROR'
+        | 'SCAN_CONFIG_ISSUE'
+        | 'AUTHENTICATION_CONFIG_ISSUE'
+        | 'TIMED_OUT_WHILE_SCANNING'
+        | 'TOO_MANY_REDIRECTS'
+        | 'TOO_MANY_HTTP_ERRORS'
+        | 'STARTING_URLS_CRAWL_HTTP_ERRORS';
       /** If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses. */
       mostCommonHttpErrorCode?: number;
       /** If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run. */
@@ -231,7 +303,13 @@ declare namespace gapi.client {
     }
     interface ScanRunWarningTrace {
       /** Indicates the warning code. */
-      code?: string;
+      code?:
+        | 'CODE_UNSPECIFIED'
+        | 'INSUFFICIENT_CRAWL_RESULTS'
+        | 'TOO_MANY_CRAWL_RESULTS'
+        | 'TOO_MANY_FUZZ_TASKS'
+        | 'BLOCKED_BY_IAP'
+        | 'NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN';
     }
     interface Schedule {
       /** Required. The duration of time between executions in days. */
@@ -265,7 +343,7 @@ declare namespace gapi.client {
     }
     interface Xxe {
       /** Location within the request where the payload was placed. */
-      payloadLocation?: string;
+      payloadLocation?: 'LOCATION_UNSPECIFIED' | 'COMPLETE_REQUEST_BODY';
       /** The XML string that triggered the XXE vulnerability. Non-payload values might be redacted. */
       payloadValue?: string;
     }
@@ -273,11 +351,11 @@ declare namespace gapi.client {
       /** List CrawledUrls under a given ScanRun. */
       list(request?: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -306,11 +384,11 @@ declare namespace gapi.client {
       /** Gets a Finding. */
       get(request?: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -333,11 +411,11 @@ declare namespace gapi.client {
       /** List Findings under a given ScanRun. */
       list(request?: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -368,11 +446,11 @@ declare namespace gapi.client {
       /** List all FindingTypeStats under a given ScanRun. */
       list(request?: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -397,11 +475,11 @@ declare namespace gapi.client {
       /** Gets a ScanRun. */
       get(request?: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -424,11 +502,11 @@ declare namespace gapi.client {
       /** Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time. */
       list(request?: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -455,11 +533,11 @@ declare namespace gapi.client {
       /** Stops a ScanRun. The stopped ScanRun is returned. */
       stop(request: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -484,11 +562,11 @@ declare namespace gapi.client {
       stop(
         request: {
           /** V1 error format. */
-          '$.xgafv'?: string;
+          '$.xgafv'?: '1' | '2';
           /** OAuth access token. */
           access_token?: string;
           /** Data format for response. */
-          alt?: string;
+          alt?: 'json' | 'media' | 'proto';
           /** JSONP */
           callback?: string;
           /** Selector specifying which fields to include in a partial response. */
@@ -518,11 +596,11 @@ declare namespace gapi.client {
       /** Creates a new ScanConfig. */
       create(request: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -547,11 +625,11 @@ declare namespace gapi.client {
       create(
         request: {
           /** V1 error format. */
-          '$.xgafv'?: string;
+          '$.xgafv'?: '1' | '2';
           /** OAuth access token. */
           access_token?: string;
           /** Data format for response. */
-          alt?: string;
+          alt?: 'json' | 'media' | 'proto';
           /** JSONP */
           callback?: string;
           /** Selector specifying which fields to include in a partial response. */
@@ -576,11 +654,11 @@ declare namespace gapi.client {
       /** Deletes an existing ScanConfig and its child resources. */
       delete(request?: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -603,11 +681,11 @@ declare namespace gapi.client {
       /** Gets a ScanConfig. */
       get(request?: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -630,11 +708,11 @@ declare namespace gapi.client {
       /** Lists ScanConfigs under a given project. */
       list(request?: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -661,11 +739,11 @@ declare namespace gapi.client {
       /** Updates a ScanConfig. This method support partial update of a ScanConfig. */
       patch(request: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -692,11 +770,11 @@ declare namespace gapi.client {
       patch(
         request: {
           /** V1 error format. */
-          '$.xgafv'?: string;
+          '$.xgafv'?: '1' | '2';
           /** OAuth access token. */
           access_token?: string;
           /** Data format for response. */
-          alt?: string;
+          alt?: 'json' | 'media' | 'proto';
           /** JSONP */
           callback?: string;
           /** Selector specifying which fields to include in a partial response. */
@@ -723,11 +801,11 @@ declare namespace gapi.client {
       /** Start a ScanRun according to the given ScanConfig. */
       start(request: {
         /** V1 error format. */
-        '$.xgafv'?: string;
+        '$.xgafv'?: '1' | '2';
         /** OAuth access token. */
         access_token?: string;
         /** Data format for response. */
-        alt?: string;
+        alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
@@ -752,11 +830,11 @@ declare namespace gapi.client {
       start(
         request: {
           /** V1 error format. */
-          '$.xgafv'?: string;
+          '$.xgafv'?: '1' | '2';
           /** OAuth access token. */
           access_token?: string;
           /** Data format for response. */
-          alt?: string;
+          alt?: 'json' | 'media' | 'proto';
           /** JSONP */
           callback?: string;
           /** Selector specifying which fields to include in a partial response. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.websecurityscanner-v1beta",
-  "version": "0.1.20251207",
+  "version": "0.2.20251207",
   "description": "TypeScript typings for Web Security Scanner API v1beta",
   "repository": {
     "type": "git",