@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20230608 → 0.0.20230620

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=v1alpha
-// Revision: 20230608
+// Revision: 20230620
 
 /// <reference types="gapi.client" />
 
@@ -186,11 +186,11 @@ declare namespace gapi.client {
                 { [P in string]: any };
         }
         interface GoogleCloudDiscoveryengineV1alphaDocumentInfo {
-            /** Required. The Document resource ID. */
+            /** The Document resource ID. */
             id?:
                 string;
             /**
-             * Required. The Document resource full name, of the form:
+             * The Document resource full name, of the form:
              * `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
              */
             name?:
@@ -204,7 +204,7 @@ declare namespace gapi.client {
              */
             quantity?:
                 number;
-            /** Required. The Document url - only allowed for DataStores with content_config PUBLIC_WEBSITE. */
+            /** The Document url - only allowed for DataStores with content_config PUBLIC_WEBSITE. */
             uri?:
                 string;
         }
@@ -213,7 +213,8 @@ declare namespace gapi.client {
              * The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid
              * Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` will become a document, with the ID set to the first 128 bits of SHA256(URI) encoded
              * as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store
-             * vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
+             * vertical. * `csv`: A CSV file with header conforming the defined Schema of the data store. Each entry after the header will be imported as a Document. This can only be used by the
+             * GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
              */
             dataSchema?:
                 string;
@@ -244,7 +245,7 @@ declare namespace gapi.client {
              * Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be
              * consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be
              * specified using id_field, otherwises, documents without IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or
-             * BigQuerySource.data_schema is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
+             * BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
              */
             autoGenerateIds?:
                 boolean;
@@ -310,16 +311,16 @@ declare namespace gapi.client {
                 string;
         }
         interface GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest {
-            /** Required. BigQuery input source. */
+            /** BigQuery input source. */
             bigquerySource?:
                 GoogleCloudDiscoveryengineV1alphaBigQuerySource;
             /** The desired location of errors incurred during the Import. Cannot be set for inline user event imports. */
             errorConfig?:
                 GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
-            /** Required. Cloud Storage location for the input content. */
+            /** Cloud Storage location for the input content. */
             gcsSource?:
                 GoogleCloudDiscoveryengineV1alphaGcsSource;
-            /** Required. The Inline source for the input content for UserEvents. */
+            /** The Inline source for the input content for UserEvents. */
             inlineSource?:
                 GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource;
         }
@@ -437,6 +438,42 @@ declare namespace gapi.client {
             purgeSample?:
                 string[];
         }
+        interface GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata {
+            /** Operation create time. */
+            createTime?:
+                string;
+            /** Count of entries that encountered errors while processing. */
+            failureCount?:
+                string;
+            /** Count of entries that were deleted successfully. */
+            successCount?:
+                string;
+            /** Operation last update time. If the operation is done, this is also the finish time. */
+            updateTime?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest {
+            /**
+             * Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted
+             * UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. *
+             * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime >
+             * "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType: `eventType = "search"` * Deleting all events for a specific visitor: `userPseudoId
+             * = "visitor1024"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.
+             */
+            filter?:
+                string;
+            /**
+             * The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false,
+             * the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request.
+             */
+            force?:
+                boolean;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse {
+            /** The total count of events purged as a result of the operation. */
+            purgeCount?:
+                string;
+        }
         interface GoogleCloudDiscoveryengineV1alphaRecommendRequest {
             /**
              * Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: *
@@ -2079,6 +2116,96 @@ declare namespace gapi.client {
                     string;
             },
             body: GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest): Request<GoogleLongrunningOperation>;
+            /**
+             * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete.
+             * To test a filter, use the list command first.
+             */
+            purge(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 resource name of the catalog under which the events are created. The format is
+                 * `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
+                 */
+                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:
+                    GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest;
+            }): Request<GoogleLongrunningOperation>;
+            purge(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 resource name of the catalog under which the events are created. The format is
+                 * `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
+                 */
+                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: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest): Request<GoogleLongrunningOperation>;
             /** Writes a single user event. */
             write(request: {
                 /** V1 error format. */
@@ -3380,6 +3507,96 @@ declare namespace gapi.client {
                     string;
             },
             body: GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest): Request<GoogleLongrunningOperation>;
+            /**
+             * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete.
+             * To test a filter, use the list command first.
+             */
+            purge(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 resource name of the catalog under which the events are created. The format is
+                 * `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
+                 */
+                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:
+                    GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest;
+            }): Request<GoogleLongrunningOperation>;
+            purge(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 resource name of the catalog under which the events are created. The format is
+                 * `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
+                 */
+                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: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest): Request<GoogleLongrunningOperation>;
             /** Writes a single user event. */
             write(request: {
                 /** V1 error format. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
-  "version": "0.0.20230608",
+  "version": "0.0.20230620",
   "description": "TypeScript typings for Discovery Engine API v1alpha",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,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
 
-// Revision: 20230608
+// Revision: 20230620
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -375,6 +375,16 @@ gapi.load('client', async () => {
                 ],
             },
         });
+        /**
+         * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To
+         * test a filter, use the list command first.
+         */
+        await gapi.client.discoveryengine.projects.locations.collections.dataStores.userEvents.purge({
+            parent: "Test string",
+        }, {
+            filter: "Test string",
+            force: true,
+        });
         /** Writes a single user event. */
         await gapi.client.discoveryengine.projects.locations.collections.dataStores.userEvents.write({
             parent: "Test string",
@@ -808,6 +818,16 @@ gapi.load('client', async () => {
                 ],
             },
         });
+        /**
+         * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To
+         * test a filter, use the list command first.
+         */
+        await gapi.client.discoveryengine.projects.locations.dataStores.userEvents.purge({
+            parent: "Test string",
+        }, {
+            filter: "Test string",
+            force: true,
+        });
         /** Writes a single user event. */
         await gapi.client.discoveryengine.projects.locations.dataStores.userEvents.write({
             parent: "Test string",