@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20230513 → 0.0.20230525

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: 20230513
+// Revision: 20230525
 
 /// <reference types="gapi.client" />
 
@@ -104,6 +104,11 @@ declare namespace gapi.client {
             functionName?:
                 string;
         }
+        interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse {
+            /** TargetSites created. */
+            targetSites?:
+                GoogleCloudDiscoveryengineV1alphaTargetSite[];
+        }
         interface GoogleCloudDiscoveryengineV1alphaBigQuerySource {
             /**
              * The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document
@@ -235,6 +240,14 @@ declare namespace gapi.client {
                 string;
         }
         interface GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest {
+            /**
+             * 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.
+             */
+            autoGenerateIds?:
+                boolean;
             /** BigQuery input source. */
             bigquerySource?:
                 GoogleCloudDiscoveryengineV1alphaBigQuerySource;
@@ -244,6 +257,16 @@ declare namespace gapi.client {
             /** Cloud Storage location for the input content. */
             gcsSource?:
                 GoogleCloudDiscoveryengineV1alphaGcsSource;
+            /**
+             * The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON
+             * `{"my_id": "some_uuid"}`. For BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column will be
+             * used as the Document.ids. The JSON field or the BigQuery column must be of string type, and the values must be set as valid strings conform to
+             * [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid 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`. And only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an
+             * INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources.
+             */
+            idField?:
+                string;
             /** The Inline source for the input content for documents. */
             inlineSource?:
                 GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource;
@@ -525,6 +548,33 @@ declare namespace gapi.client {
             searchQuery?:
                 string;
         }
+        interface GoogleCloudDiscoveryengineV1alphaTargetSite {
+            /**
+             * Input only. If set to false, an uri_pattern will be generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern will be generated
+             * to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern will always be normalized to
+             * generate the uri pattern to be used by the search engine.
+             */
+            exactMatch?:
+                boolean;
+            /** Output only. This is system-generated based on the provided_uri_pattern. */
+            generatedUriPattern?:
+                string;
+            /**
+             * Output only. The fully qualified resource name of the target site.
+             * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.
+             */
+            name?:
+                string;
+            /** Required. Input only. The user provided uri pattern from which the `generated_uri_pattern` is generated. */
+            providedUriPattern?:
+                string;
+            /** The type of the target site, e.g. whether the site is to be included or excluded. */
+            type?:
+                string;
+            /** Output only. The target site's last updated time. */
+            updateTime?:
+                string;
+        }
         interface GoogleCloudDiscoveryengineV1alphaTransactionInfo {
             /**
              * All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax -
@@ -764,6 +814,100 @@ declare namespace gapi.client {
             structSchema?:
                 { [P in string]: any };
         }
+        interface GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
+            /** Operation create time. */
+            createTime?:
+                string;
+            /** Count of entries that encountered errors while processing. */
+            failureCount?:
+                string;
+            /** Count of entries that were processed successfully. */
+            successCount?:
+                string;
+            /** Operation last update time. If the operation is done, this is also the finish time. */
+            updateTime?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1ImportDocumentsResponse {
+            /** Echoes the destination for the complete errors in the request if set. */
+            errorConfig?:
+                GoogleCloudDiscoveryengineV1ImportErrorConfig;
+            /** A sample of errors encountered while processing the request. */
+            errorSamples?:
+                GoogleRpcStatus[];
+        }
+        interface GoogleCloudDiscoveryengineV1ImportErrorConfig {
+            /**
+             * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a
+             * JSON-encoded `google.rpc.Status` message.
+             */
+            gcsPrefix?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1ImportUserEventsMetadata {
+            /** Operation create time. */
+            createTime?:
+                string;
+            /** Count of entries that encountered errors while processing. */
+            failureCount?:
+                string;
+            /** Count of entries that were processed successfully. */
+            successCount?:
+                string;
+            /** Operation last update time. If the operation is done, this is also the finish time. */
+            updateTime?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1ImportUserEventsResponse {
+            /** Echoes the destination for the complete errors if this field was set in the request. */
+            errorConfig?:
+                GoogleCloudDiscoveryengineV1ImportErrorConfig;
+            /** A sample of errors encountered while processing the request. */
+            errorSamples?:
+                GoogleRpcStatus[];
+            /** Count of user events imported with complete existing Documents. */
+            joinedEventsCount?:
+                string;
+            /** Count of user events imported, but with Document information not found in the existing Branch. */
+            unjoinedEventsCount?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
+            /** 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 GoogleCloudDiscoveryengineV1PurgeDocumentsResponse {
+            /** The total count of documents purged as a result of the operation. */
+            purgeCount?:
+                string;
+            /** A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */
+            purgeSample?:
+                string[];
+        }
+        interface GoogleCloudDiscoveryengineV1Schema {
+            /** The JSON representation of the schema. */
+            jsonSchema?:
+                string;
+            /**
+             * Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This
+             * field must be a UTF-8 encoded string with a length limit of 1024 characters.
+             */
+            name?:
+                string;
+            /** The structured representation of the schema. */
+            structSchema?:
+                { [P in string]: any };
+        }
         interface GoogleLongrunningListOperationsResponse {
             /** The standard List next-page token. */
             nextPageToken?:
@@ -1614,6 +1758,99 @@ declare namespace gapi.client {
                     string;
             }): Request<GoogleLongrunningListOperationsResponse>;
         }
+        interface OperationsResource {
+            /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
+            get(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;
+                /** The name of the operation resource. */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    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<GoogleLongrunningOperation>;
+            /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
+            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;
+                /** The standard list filter. */
+                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;
+                /** The name of the operation's parent resource. */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** The standard list page size. */
+                pageSize?:
+                    number;
+                /** The standard list page token. */
+                pageToken?:
+                    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<GoogleLongrunningListOperationsResponse>;
+        }
+        interface SchemasResource {
+            operations:
+                OperationsResource;
+        }
         interface ServingConfigsResource {
             /** Makes a recommendation, which requires a contextual user event. */
             recommend(request: {
@@ -1931,6 +2168,8 @@ declare namespace gapi.client {
                 ModelsResource;
             operations:
                 OperationsResource;
+            schemas:
+                SchemasResource;
             servingConfigs:
                 ServingConfigsResource;
             userEvents:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
-  "version": "0.0.20230513",
+  "version": "0.0.20230525",
   "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: 20230513
+// Revision: 20230525
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -58,6 +58,7 @@ gapi.load('client', async () => {
         await gapi.client.discoveryengine.projects.locations.collections.dataStores.branches.documents.import({
             parent: "Test string",
         }, {
+            autoGenerateIds: true,
             bigquerySource: {
                 dataSchema: "Test string",
                 datasetId: "Test string",
@@ -79,6 +80,7 @@ gapi.load('client', async () => {
                     "Test string"
                 ],
             },
+            idField: "Test string",
             inlineSource: {
                 documents: [
                     {
@@ -159,6 +161,17 @@ gapi.load('client', async () => {
             pageSize: 42,
             pageToken: "Test string",
         });
+        /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
+        await gapi.client.discoveryengine.projects.locations.collections.dataStores.schemas.operations.get({
+            name: "Test string",
+        });
+        /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
+        await gapi.client.discoveryengine.projects.locations.collections.dataStores.schemas.operations.list({
+            filter: "Test string",
+            name: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+        });
         /** Makes a recommendation, which requires a contextual user event. */
         await gapi.client.discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend({
             servingConfig: "Test string",
@@ -489,6 +502,7 @@ gapi.load('client', async () => {
         await gapi.client.discoveryengine.projects.locations.dataStores.branches.documents.import({
             parent: "Test string",
         }, {
+            autoGenerateIds: true,
             bigquerySource: {
                 dataSchema: "Test string",
                 datasetId: "Test string",
@@ -510,6 +524,7 @@ gapi.load('client', async () => {
                     "Test string"
                 ],
             },
+            idField: "Test string",
             inlineSource: {
                 documents: [
                     {