@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20230608 → 0.0.20230623

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.
Files changed (3) hide show
  1. package/index.d.ts +77 -55
  2. package/package.json +1 -1
  3. package/tests.ts +3 -3
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20230608
12
+ // Revision: 20230623
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -133,7 +133,7 @@ declare namespace gapi.client {
133
133
  }
134
134
  interface GoogleCloudDiscoveryengineV1alphaImportErrorConfig {
135
135
  /**
136
- * 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
136
+ * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a
137
137
  * JSON-encoded `google.rpc.Status` message.
138
138
  */
139
139
  gcsPrefix?:
@@ -189,6 +189,25 @@ declare namespace gapi.client {
189
189
  purgeSample?:
190
190
  string[];
191
191
  }
192
+ interface GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata {
193
+ /** Operation create time. */
194
+ createTime?:
195
+ string;
196
+ /** Count of entries that encountered errors while processing. */
197
+ failureCount?:
198
+ string;
199
+ /** Count of entries that were deleted successfully. */
200
+ successCount?:
201
+ string;
202
+ /** Operation last update time. If the operation is done, this is also the finish time. */
203
+ updateTime?:
204
+ string;
205
+ }
206
+ interface GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse {
207
+ /** The total count of events purged as a result of the operation. */
208
+ purgeCount?:
209
+ string;
210
+ }
192
211
  interface GoogleCloudDiscoveryengineV1alphaSchema {
193
212
  /** The JSON representation of the schema. */
194
213
  jsonSchema?:
@@ -205,9 +224,9 @@ declare namespace gapi.client {
205
224
  }
206
225
  interface GoogleCloudDiscoveryengineV1alphaTargetSite {
207
226
  /**
208
- * 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
209
- * 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
210
- * generate the uri pattern to be used by the search engine.
227
+ * Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to
228
+ * 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 is always normalized to generate the URI
229
+ * pattern to be used by the search engine.
211
230
  */
212
231
  exactMatch?:
213
232
  boolean;
@@ -220,7 +239,7 @@ declare namespace gapi.client {
220
239
  */
221
240
  name?:
222
241
  string;
223
- /** Required. Input only. The user provided uri pattern from which the `generated_uri_pattern` is generated. */
242
+ /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
224
243
  providedUriPattern?:
225
244
  string;
226
245
  /** The type of the target site, e.g. whether the site is to be included or excluded. */
@@ -234,7 +253,7 @@ declare namespace gapi.client {
234
253
  /**
235
254
  * 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
236
255
  * imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One
237
- * custom data 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.
256
+ * custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
238
257
  */
239
258
  dataSchema?:
240
259
  string;
@@ -258,10 +277,10 @@ declare namespace gapi.client {
258
277
  string;
259
278
  }
260
279
  interface GoogleCloudDiscoveryengineV1betaCompletionInfo {
261
- /** End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0. */
280
+ /** End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0. */
262
281
  selectedPosition?:
263
282
  number;
264
- /** End user selected CompleteQueryResponse.CompletionResult.suggestion. */
283
+ /** End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */
265
284
  selectedSuggestion?:
266
285
  string;
267
286
  }
@@ -283,7 +302,7 @@ declare namespace gapi.client {
283
302
  /** Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
284
303
  id?:
285
304
  string;
286
- /** The JSON string representation of the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown. */
305
+ /** The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
287
306
  jsonData?:
288
307
  string;
289
308
  /**
@@ -302,16 +321,16 @@ declare namespace gapi.client {
302
321
  /** The identifier of the schema located in the same data store. */
303
322
  schemaId?:
304
323
  string;
305
- /** The structured JSON data for the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown. */
324
+ /** The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
306
325
  structData?:
307
326
  { [P in string]: any };
308
327
  }
309
328
  interface GoogleCloudDiscoveryengineV1betaDocumentInfo {
310
- /** Required. The Document resource ID. */
329
+ /** The Document resource ID. */
311
330
  id?:
312
331
  string;
313
332
  /**
314
- * Required. The Document resource full name, of the form:
333
+ * The Document resource full name, of the form:
315
334
  * `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
316
335
  */
317
336
  name?:
@@ -325,16 +344,17 @@ declare namespace gapi.client {
325
344
  */
326
345
  quantity?:
327
346
  number;
328
- /** Required. The Document url - only allowed for DataStores with content_config PUBLIC_WEBSITE. */
347
+ /** The Document URI - only allowed for website data stores. */
329
348
  uri?:
330
349
  string;
331
350
  }
332
351
  interface GoogleCloudDiscoveryengineV1betaGcsSource {
333
352
  /**
334
353
  * 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
335
- * 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
336
- * 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
337
- * vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
354
+ * Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a
355
+ * hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. * `csv`: A
356
+ * CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder. Supported
357
+ * values for user even imports: * `user_event` (default): One JSON UserEvent per line.
338
358
  */
339
359
  dataSchema?:
340
360
  string;
@@ -364,8 +384,8 @@ declare namespace gapi.client {
364
384
  /**
365
385
  * 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
366
386
  * 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
367
- * 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
368
- * BigQuerySource.data_schema is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
387
+ * specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or
388
+ * BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
369
389
  */
370
390
  autoGenerateIds?:
371
391
  boolean;
@@ -380,9 +400,9 @@ declare namespace gapi.client {
380
400
  GoogleCloudDiscoveryengineV1betaGcsSource;
381
401
  /**
382
402
  * 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
383
- * `{"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
403
+ * `{"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 are
384
404
  * 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
385
- * [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
405
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when using GcsSource or
386
406
  * 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
387
407
  * INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources.
388
408
  */
@@ -410,7 +430,7 @@ declare namespace gapi.client {
410
430
  }
411
431
  interface GoogleCloudDiscoveryengineV1betaImportErrorConfig {
412
432
  /**
413
- * 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
433
+ * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a
414
434
  * JSON-encoded `google.rpc.Status` message.
415
435
  */
416
436
  gcsPrefix?:
@@ -431,16 +451,16 @@ declare namespace gapi.client {
431
451
  string;
432
452
  }
433
453
  interface GoogleCloudDiscoveryengineV1betaImportUserEventsRequest {
434
- /** Required. BigQuery input source. */
454
+ /** BigQuery input source. */
435
455
  bigquerySource?:
436
456
  GoogleCloudDiscoveryengineV1betaBigQuerySource;
437
457
  /** The desired location of errors incurred during the Import. Cannot be set for inline user event imports. */
438
458
  errorConfig?:
439
459
  GoogleCloudDiscoveryengineV1betaImportErrorConfig;
440
- /** Required. Cloud Storage location for the input content. */
460
+ /** Cloud Storage location for the input content. */
441
461
  gcsSource?:
442
462
  GoogleCloudDiscoveryengineV1betaGcsSource;
443
- /** Required. The Inline source for the input content for UserEvents. */
463
+ /** The Inline source for the input content for UserEvents. */
444
464
  inlineSource?:
445
465
  GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource;
446
466
  }
@@ -489,14 +509,14 @@ declare namespace gapi.client {
489
509
  /**
490
510
  * The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name,
491
511
  * please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy:
492
- * "pageCategory" : "Sales > 2017 Black Friday Deals". Required for `view-category-page` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is
493
- * returned.
512
+ * `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error
513
+ * is returned.
494
514
  */
495
515
  pageCategory?:
496
516
  string;
497
517
  /**
498
518
  * A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple
499
- * events as the user is browsing the page. The `pageViewId` property should be kept the same for all these events so that they can be grouped together properly. When using the client
519
+ * events as the user is browsing the page. The `pageview_id` property should be kept the same for all these events so that they can be grouped together properly. When using the client
500
520
  * side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.
501
521
  */
502
522
  pageviewId?:
@@ -649,22 +669,22 @@ declare namespace gapi.client {
649
669
  interface GoogleCloudDiscoveryengineV1betaSearchInfo {
650
670
  /**
651
671
  * An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for
652
- * definition. If this field is negative, an INVALID_ARGUMENT is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an
653
- * INVALID_ARGUMENT error is returned.
672
+ * definition. If this field is negative, an `INVALID_ARGUMENT` is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an
673
+ * `INVALID_ARGUMENT` error is returned.
654
674
  */
655
675
  offset?:
656
676
  number;
657
677
  /**
658
678
  * The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000
659
- * characters. Otherwise, an INVALID_ARGUMENT error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT
660
- * error is returned.
679
+ * characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an
680
+ * `INVALID_ARGUMENT` error is returned.
661
681
  */
662
682
  orderBy?:
663
683
  string;
664
684
  /**
665
- * The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT
685
+ * The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT`
666
686
  * error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an
667
- * INVALID_ARGUMENT error is returned.
687
+ * `INVALID_ARGUMENT` error is returned.
668
688
  */
669
689
  searchQuery?:
670
690
  string;
@@ -703,22 +723,25 @@ declare namespace gapi.client {
703
723
  * consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving
704
724
  * predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8
705
725
  * encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded
706
- * string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `
707
- * traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
726
+ * string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is
727
+ * `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
708
728
  */
709
729
  attributes?:
710
730
  { [P in string]: GoogleCloudDiscoveryengineV1betaCustomAttribute };
711
731
  /**
712
732
  * Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field
713
- * enables accurate attribution of recommendation model performance. The value must be one of: * PredictResponse.attribution_token for events that are the result of
714
- * RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. * CompleteQueryResponse.attribution_token for events that
715
- * are the result of CompletionService.CompleteQuery. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict
716
- * response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass PredictResponse.attribution_token as a URL parameter to product
717
- * K's page. When recording events on product K's page, log the PredictResponse.attribution_token to this field.
733
+ * enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of
734
+ * RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view
735
+ * or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results,
736
+ * pass RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this
737
+ * field.
718
738
  */
719
739
  attributionToken?:
720
740
  string;
721
- /** CompleteQuery API details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search. */
741
+ /**
742
+ * CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for
743
+ * search.
744
+ */
722
745
  completionInfo?:
723
746
  GoogleCloudDiscoveryengineV1betaCompletionInfo;
724
747
  /**
@@ -750,7 +773,7 @@ declare namespace gapi.client {
750
773
  * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the
751
774
  * associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are
752
775
  * generated from a RecommendationService.RecommendRequest, this field may be populated directly from RecommendationService.RecommendRequest.filter conforming to
753
- * https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
776
+ * https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
754
777
  */
755
778
  filter?:
756
779
  string;
@@ -766,7 +789,7 @@ declare namespace gapi.client {
766
789
  /** The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. */
767
790
  promotionIds?:
768
791
  string[];
769
- /** Search API details related to the event. This field should be set for `search` event. */
792
+ /** SearchService.Search details related to the event. This field should be set for `search` event. */
770
793
  searchInfo?:
771
794
  GoogleCloudDiscoveryengineV1betaSearchInfo;
772
795
  /**
@@ -792,7 +815,7 @@ declare namespace gapi.client {
792
815
  * Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single
793
816
  * device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event
794
817
  * 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
795
- * INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client
818
+ * `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client
796
819
  * ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.
797
820
  */
798
821
  userPseudoId?:
@@ -800,9 +823,8 @@ declare namespace gapi.client {
800
823
  }
801
824
  interface GoogleCloudDiscoveryengineV1betaUserInfo {
802
825
  /**
803
- * User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters.
804
- * Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent
805
- * or if UserEvent.direct_user_request is set.
826
+ * User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This
827
+ * should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
806
828
  */
807
829
  userAgent?:
808
830
  string;
@@ -838,7 +860,7 @@ declare namespace gapi.client {
838
860
  }
839
861
  interface GoogleCloudDiscoveryengineV1ImportErrorConfig {
840
862
  /**
841
- * 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
863
+ * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a
842
864
  * JSON-encoded `google.rpc.Status` message.
843
865
  */
844
866
  gcsPrefix?:
@@ -1282,7 +1304,7 @@ declare namespace gapi.client {
1282
1304
  string;
1283
1305
  /**
1284
1306
  * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use
1285
- * `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether
1307
+ * `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether
1286
1308
  * or not this branch exists, a `PERMISSION_DENIED` error is returned.
1287
1309
  */
1288
1310
  parent:
@@ -1942,7 +1964,7 @@ declare namespace gapi.client {
1942
1964
  }
1943
1965
  interface UserEventsResource {
1944
1966
  /**
1945
- * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery
1967
+ * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery
1946
1968
  * Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
1947
1969
  */
1948
1970
  collect(request?: {
@@ -1987,7 +2009,7 @@ declare namespace gapi.client {
1987
2009
  string;
1988
2010
  /**
1989
2011
  * The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers
1990
- * only send the domain for 3rd party requests.
2012
+ * only send the domain for third-party requests.
1991
2013
  */
1992
2014
  uri?:
1993
2015
  string;
@@ -2676,7 +2698,7 @@ declare namespace gapi.client {
2676
2698
  string;
2677
2699
  /**
2678
2700
  * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use
2679
- * `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether
2701
+ * `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether
2680
2702
  * or not this branch exists, a `PERMISSION_DENIED` error is returned.
2681
2703
  */
2682
2704
  parent:
@@ -3243,7 +3265,7 @@ declare namespace gapi.client {
3243
3265
  }
3244
3266
  interface UserEventsResource {
3245
3267
  /**
3246
- * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery
3268
+ * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery
3247
3269
  * Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
3248
3270
  */
3249
3271
  collect(request?: {
@@ -3288,7 +3310,7 @@ declare namespace gapi.client {
3288
3310
  string;
3289
3311
  /**
3290
3312
  * The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers
3291
- * only send the domain for 3rd party requests.
3313
+ * only send the domain for third-party requests.
3292
3314
  */
3293
3315
  uri?:
3294
3316
  string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.0.20230608",
3
+ "version": "0.0.20230623",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230608
6
+ // Revision: 20230623
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -260,7 +260,7 @@ gapi.load('client', async () => {
260
260
  validateOnly: true,
261
261
  });
262
262
  /**
263
- * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine
263
+ * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine
264
264
  * API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
265
265
  */
266
266
  await gapi.client.discoveryengine.projects.locations.collections.dataStores.userEvents.collect({
@@ -693,7 +693,7 @@ gapi.load('client', async () => {
693
693
  validateOnly: true,
694
694
  });
695
695
  /**
696
- * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine
696
+ * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine
697
697
  * API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
698
698
  */
699
699
  await gapi.client.discoveryengine.projects.locations.dataStores.userEvents.collect({