@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20250430 → 0.0.20250509

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1
-// Revision: 20250430
+// Revision: 20250509
 
 /// <reference types="gapi.client" />
 
@@ -436,6 +436,22 @@ declare namespace gapi.client {
       /** TargetSites created. */
       targetSites?: GoogleCloudDiscoveryengineV1alphaTargetSite[];
     }
+    interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Count of user licenses that failed to be updated. */
+      failureCount?: string;
+      /** Count of user licenses successfully updated. */
+      successCount?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse {
+      /** A sample of errors encountered while processing the request. */
+      errorSamples?: GoogleRpcStatus[];
+      /** UserLicenses successfully updated. */
+      userLicenses?: GoogleCloudDiscoveryengineV1alphaUserLicense[];
+    }
     interface GoogleCloudDiscoveryengineV1alphaCmekConfig {
       /** Output only. The default CmekConfig for the Customer. */
       isDefault?: boolean;
@@ -551,7 +567,7 @@ declare namespace gapi.client {
       filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
       /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
       name?: string;
-      /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
+      /** Promote certain links based on predefined trigger queries. */
       promoteAction?: GoogleCloudDiscoveryengineV1alphaControlPromoteAction;
       /** Defines a redirect-type control. */
       redirectAction?: GoogleCloudDiscoveryengineV1alphaControlRedirectAction;
@@ -656,7 +672,7 @@ declare namespace gapi.client {
       actionConfig?: GoogleCloudDiscoveryengineV1alphaActionConfig;
       /** Optional. The connector level alert config. */
       alertPolicyConfigs?: GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig[];
-      /** Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. */
+      /** Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs */
       autoRunDisabled?: boolean;
       /** Optional. The configuration for establishing a BAP connection. */
       bapConfig?: GoogleCloudDiscoveryengineV1alphaBAPConfig;
@@ -664,8 +680,10 @@ declare namespace gapi.client {
       blockingReasons?: string[];
       /** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
       connectorModes?: string[];
-      /** Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system. */
+      /** Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */
       connectorType?: string;
+      /** Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. */
+      createEuaSaas?: boolean;
       /** Output only. Timestamp the DataConnector was created at. */
       createTime?: string;
       /** Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. */
@@ -682,6 +700,10 @@ declare namespace gapi.client {
       identityRefreshInterval?: string;
       /** The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. */
       identityScheduleConfig?: GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig;
+      /** Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. */
+      incrementalRefreshInterval?: string;
+      /** Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. */
+      incrementalSyncDisabled?: boolean;
       /** Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. */
       kmsKeyName?: string;
       /** Output only. For periodic connectors only, the last time a data sync was completed. */
@@ -1687,6 +1709,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
       /** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
       boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
+      /** Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). */
+      customSearchOperators?: string;
       /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
       dataStore?: string;
       /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
@@ -1925,6 +1949,24 @@ declare namespace gapi.client {
       /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
       userId?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaUserLicense {
+      /** Output only. User created timestamp. */
+      createTime?: string;
+      /** Output only. User last logged in time. If the user has not logged in yet, this field will be empty. */
+      lastLoginTime?: string;
+      /** Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user; */
+      licenseAssignmentState?: string;
+      /** Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. */
+      licenseConfig?: string;
+      /** Output only. User update timestamp. */
+      updateTime?: string;
+      /** Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created. */
+      user?: string;
+      /** Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal. */
+      userPrincipal?: string;
+      /** Optional. The user profile. We user user full name(First name + Last name) as user profile. */
+      userProfile?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
       /** Obfuscated Dasher customer ID. */
       dasherCustomerId?: string;
@@ -2367,6 +2409,20 @@ declare namespace gapi.client {
       /** If match by URI, the URI of the Document. */
       uri?: string;
     }
+    interface GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest {
+      /** Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state. */
+      deleteUnassignedUserLicenses?: boolean;
+      /** Cloud Storage location for the input content. */
+      gcsSource?: GoogleCloudDiscoveryengineV1GcsSource;
+      /** The inline source for the input content for document embeddings. */
+      inlineSource?: GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource;
+    }
+    interface GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource {
+      /** Optional. The list of fields to update. */
+      updateMask?: string;
+      /** Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal. */
+      userLicenses?: GoogleCloudDiscoveryengineV1UserLicense[];
+    }
     interface GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {}
     interface GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig {
       /** If set true, automatic refresh is disabled for the DataStore. */
@@ -2435,7 +2491,7 @@ declare namespace gapi.client {
       filterAction?: GoogleCloudDiscoveryengineV1betaControlFilterAction;
       /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
       name?: string;
-      /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
+      /** Promote certain links based on predefined trigger queries. */
       promoteAction?: GoogleCloudDiscoveryengineV1betaControlPromoteAction;
       /** Defines a redirect-type control. */
       redirectAction?: GoogleCloudDiscoveryengineV1betaControlRedirectAction;
@@ -3256,6 +3312,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
       /** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
       boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
+      /** Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). */
+      customSearchOperators?: string;
       /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
       dataStore?: string;
       /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
@@ -3537,7 +3595,7 @@ declare namespace gapi.client {
       endPos?: number;
       /** Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned. */
       groundingCheckRequired?: boolean;
-      /** Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true. */
+      /** Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true. */
       score?: number;
       /** Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent). */
       startPos?: number;
@@ -3689,7 +3747,7 @@ declare namespace gapi.client {
       filterAction?: GoogleCloudDiscoveryengineV1ControlFilterAction;
       /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
       name?: string;
-      /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
+      /** Promote certain links based on predefined trigger queries. */
       promoteAction?: GoogleCloudDiscoveryengineV1ControlPromoteAction;
       /** Defines a redirect-type control. */
       redirectAction?: GoogleCloudDiscoveryengineV1ControlRedirectAction;
@@ -4521,6 +4579,12 @@ declare namespace gapi.client {
       /** The total number of items matching the request. This will always be populated in the response. */
       totalSize?: number;
     }
+    interface GoogleCloudDiscoveryengineV1ListUserLicensesResponse {
+      /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+      nextPageToken?: string;
+      /** All the customer's UserLicenses. */
+      userLicenses?: GoogleCloudDiscoveryengineV1UserLicense[];
+    }
     interface GoogleCloudDiscoveryengineV1MediaInfo {
       /** The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. */
       mediaProgressDuration?: string;
@@ -4945,6 +5009,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec {
       /** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
       boostSpec?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec;
+      /** Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). */
+      customSearchOperators?: string;
       /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
       dataStore?: string;
       /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
@@ -5410,6 +5476,24 @@ declare namespace gapi.client {
       /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
       userId?: string;
     }
+    interface GoogleCloudDiscoveryengineV1UserLicense {
+      /** Output only. User created timestamp. */
+      createTime?: string;
+      /** Output only. User last logged in time. If the user has not logged in yet, this field will be empty. */
+      lastLoginTime?: string;
+      /** Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user; */
+      licenseAssignmentState?: string;
+      /** Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. */
+      licenseConfig?: string;
+      /** Output only. User update timestamp. */
+      updateTime?: string;
+      /** Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created. */
+      user?: string;
+      /** Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal. */
+      userPrincipal?: string;
+      /** Optional. The user profile. We user user full name(First name + Last name) as user profile. */
+      userProfile?: string;
+    }
     interface GoogleCloudDiscoveryengineV1WorkspaceConfig {
       /** Obfuscated Dasher customer ID. */
       dasherCustomerId?: string;
@@ -14741,6 +14825,102 @@ declare namespace gapi.client {
         body: GoogleCloudDiscoveryengineV1UserEvent,
       ): Request<GoogleCloudDiscoveryengineV1UserEvent>;
     }
+    interface UserLicensesResource {
+      /** Lists the User Licenses. */
+      list(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. */
+        filter?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. */
+        pageSize?: number;
+        /** Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. */
+        pageToken?: string;
+        /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
+        parent: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<GoogleCloudDiscoveryengineV1ListUserLicensesResponse>;
+    }
+    interface UserStoresResource {
+      /** Updates the User License. This method is used for batch assign/unassign licenses to users. */
+      batchUpdateUserLicenses(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
+        parent: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest;
+      }): Request<GoogleLongrunningOperation>;
+      batchUpdateUserLicenses(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
+          parent: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest,
+      ): Request<GoogleLongrunningOperation>;
+      userLicenses: UserLicensesResource;
+    }
     interface LocationsResource {
       /** Gets the CmekConfig. */
       getCmekConfig(request?: {
@@ -14840,6 +15020,7 @@ declare namespace gapi.client {
       podcasts: PodcastsResource;
       rankingConfigs: RankingConfigsResource;
       userEvents: UserEventsResource;
+      userStores: UserStoresResource;
     }
     interface OperationsResource {
       /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1",
-  "version": "0.0.20250430",
+  "version": "0.0.20250509",
   "description": "TypeScript typings for Discovery Engine API v1",
   "repository": {
     "type": "git",