@maxim_mazurok/gapi.client.cloudsearch-v1 0.0.20230510 → 0.0.20230531

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 (4) hide show
  1. package/index.d.ts +172 -30
  2. package/package.json +1 -1
  3. package/readme.md +5 -0
  4. package/tests.ts +22 -1
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://cloudsearch.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230510
12
+ // Revision: 20230531
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -366,7 +366,7 @@ declare namespace gapi.client {
366
366
  /** Summary of a Data Loss Prevention (DLP) scan of the attachment. Attachments are evaluated in the backend when they are uploaded. */
367
367
  dlpScanSummary?:
368
368
  DlpScanSummary;
369
- /** The list of experiments this video is enabled for Next tag: 19 */
369
+ /** The list of experiments this video is enabled for */
370
370
  experiment?:
371
371
  string[];
372
372
  /** GroupId to which this attachment is uploaded. */
@@ -375,6 +375,8 @@ declare namespace gapi.client {
375
375
  /** If the uploaded file is a video that has been transcoded on the client side */
376
376
  isClientSideTranscodedVideo?:
377
377
  boolean;
378
+ migratedFromHangoutsMetadata?:
379
+ AppsDynamiteSharedBackendUploadMetadataMigratedFromHangoutsMetadata;
378
380
  /** Original dimension of the content. Only set for image attachments. */
379
381
  originalDimension?:
380
382
  AppsDynamiteSharedDimension;
@@ -404,6 +406,18 @@ declare namespace gapi.client {
404
406
  virusScanResult?:
405
407
  string;
406
408
  }
409
+ interface AppsDynamiteSharedBackendUploadMetadataMigratedFromHangoutsMetadata {
410
+ photoId?:
411
+ AppsDynamiteSharedBackendUploadMetadataMigratedFromHangoutsMetadataPhotoId;
412
+ updateTimestampUsec?:
413
+ string;
414
+ }
415
+ interface AppsDynamiteSharedBackendUploadMetadataMigratedFromHangoutsMetadataPhotoId {
416
+ photoId?:
417
+ string;
418
+ userId?:
419
+ string;
420
+ }
407
421
  interface AppsDynamiteSharedCalendarEventAnnotationData {
408
422
  calendarEvent?:
409
423
  AppsDynamiteSharedCalendarEventAnnotationDataCalendarEvent;
@@ -692,8 +706,8 @@ declare namespace gapi.client {
692
706
  }
693
707
  interface AppsDynamiteSharedMessageSearchInfo {
694
708
  /**
695
- * An example use case: clients can use this field to highlight matched segments in message text_body defined in
696
- * http://google3/apps/dynamite/v1/frontend/api/message.proto;l=104;rcl=513400736.
709
+ * Current usage: - DescriptionType=KEYWORD_MATCH is populated in this field to return metadata for keyword matches, which clients can use to highlight matched segments in a message's
710
+ * text_body. - DescriptionType=SNIPPET can be used to return metadata describing how a message's text_body can be broken up to provide a snippet.
697
711
  */
698
712
  matchedSegmentsInTextBody?:
699
713
  AppsDynamiteSharedTextSegmentsWithDescription[];
@@ -1827,6 +1841,9 @@ declare namespace gapi.client {
1827
1841
  */
1828
1842
  supportUrls?:
1829
1843
  SupportUrls;
1844
+ /** Determine how uninstall is permitted for this app. */
1845
+ uninstallCapability?:
1846
+ string;
1830
1847
  }
1831
1848
  interface BotResponse {
1832
1849
  botId?:
@@ -3445,7 +3462,7 @@ declare namespace gapi.client {
3445
3462
  GoogleChatV1WidgetMarkupOnClick;
3446
3463
  }
3447
3464
  interface GoogleChatV1ContextualAddOnMarkupCardCardHeader {
3448
- /** The image's type (e.g. square border or circular border). */
3465
+ /** The image's type (for example, square border or circular border). */
3449
3466
  imageStyle?:
3450
3467
  string;
3451
3468
  /** The URL of the image in the card header. */
@@ -3455,7 +3472,7 @@ declare namespace gapi.client {
3455
3472
  subtitle?:
3456
3473
  string;
3457
3474
  /**
3458
- * The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each will take up 1 line. If only the title is specified, it will take up both
3475
+ * The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each takes up one line. If only the title is specified, it takes up both
3459
3476
  * lines.
3460
3477
  */
3461
3478
  title?:
@@ -3463,12 +3480,13 @@ declare namespace gapi.client {
3463
3480
  }
3464
3481
  interface GoogleChatV1ContextualAddOnMarkupCardSection {
3465
3482
  /**
3466
- * The header of the section. Formatted text is supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace
3467
- * Add-ons.
3483
+ * The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat
3484
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
3485
+ * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
3468
3486
  */
3469
3487
  header?:
3470
3488
  string;
3471
- /** A section must contain at least 1 widget. */
3489
+ /** A section must contain at least one widget. */
3472
3490
  widgets?:
3473
3491
  GoogleChatV1WidgetMarkup[];
3474
3492
  }
@@ -3487,17 +3505,17 @@ declare namespace gapi.client {
3487
3505
  GoogleChatV1WidgetMarkupTextParagraph;
3488
3506
  }
3489
3507
  interface GoogleChatV1WidgetMarkupButton {
3490
- /** A button with image and onclick action. */
3508
+ /** A button with image and `onclick` action. */
3491
3509
  imageButton?:
3492
3510
  GoogleChatV1WidgetMarkupImageButton;
3493
- /** A button with text and onclick action. */
3511
+ /** A button with text and `onclick` action. */
3494
3512
  textButton?:
3495
3513
  GoogleChatV1WidgetMarkupTextButton;
3496
3514
  }
3497
3515
  interface GoogleChatV1WidgetMarkupFormAction {
3498
3516
  /**
3499
- * The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. The same
3500
- * method name can be used for several elements that trigger a common behavior if desired.
3517
+ * The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can
3518
+ * use the same method name for several elements that trigger a common behavior.
3501
3519
  */
3502
3520
  actionMethodName?:
3503
3521
  string;
@@ -3515,36 +3533,37 @@ declare namespace gapi.client {
3515
3533
  }
3516
3534
  interface GoogleChatV1WidgetMarkupImage {
3517
3535
  /**
3518
- * The aspect ratio of this image (width/height). This field allows clients to reserve the right height for the image while waiting for it to load. It's not meant to override the
3519
- * native aspect ratio of the image. If unset, the server fills it by prefetching the image.
3536
+ * The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in
3537
+ * aspect ratio of the image. If unset, the server fills it by prefetching the image.
3520
3538
  */
3521
3539
  aspectRatio?:
3522
3540
  number;
3523
3541
  /** The URL of the image. */
3524
3542
  imageUrl?:
3525
3543
  string;
3526
- /** The onclick action. */
3544
+ /** The `onclick` action. */
3527
3545
  onClick?:
3528
3546
  GoogleChatV1WidgetMarkupOnClick;
3529
3547
  }
3530
3548
  interface GoogleChatV1WidgetMarkupImageButton {
3531
- /** The icon specified by an enum that indices to an icon provided by Chat API. */
3549
+ /** The icon specified by an `enum` that indices to an icon provided by Chat API. */
3532
3550
  icon?:
3533
3551
  string;
3534
3552
  /** The icon specified by a URL. */
3535
3553
  iconUrl?:
3536
3554
  string;
3537
- /** The name of this image_button which will be used for accessibility. Default value will be provided if developers don't specify. */
3555
+ /** The name of this `image_button` that's used for accessibility. Default value is provided if this name isn't specified. */
3538
3556
  name?:
3539
3557
  string;
3540
- /** The onclick action. */
3558
+ /** The `onclick` action. */
3541
3559
  onClick?:
3542
3560
  GoogleChatV1WidgetMarkupOnClick;
3543
3561
  }
3544
3562
  interface GoogleChatV1WidgetMarkupKeyValue {
3545
3563
  /**
3546
- * The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace
3547
- * Add-ons.
3564
+ * The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat
3565
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
3566
+ * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
3548
3567
  */
3549
3568
  bottomLabel?:
3550
3569
  string;
@@ -3552,35 +3571,37 @@ declare namespace gapi.client {
3552
3571
  button?:
3553
3572
  GoogleChatV1WidgetMarkupButton;
3554
3573
  /**
3555
- * The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in
3556
- * Google Workspace Add-ons.
3574
+ * The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat
3575
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
3576
+ * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
3557
3577
  */
3558
3578
  content?:
3559
3579
  string;
3560
3580
  /** If the content should be multiline. */
3561
3581
  contentMultiline?:
3562
3582
  boolean;
3563
- /** An enum value that will be replaced by the Chat API with the corresponding icon image. */
3583
+ /** An enum value that's replaced by the Chat API with the corresponding icon image. */
3564
3584
  icon?:
3565
3585
  string;
3566
3586
  /** The icon specified by a URL. */
3567
3587
  iconUrl?:
3568
3588
  string;
3569
- /** The onclick action. Only the top label, bottom label and content region are clickable. */
3589
+ /** The `onclick` action. Only the top label, bottom label, and content region are clickable. */
3570
3590
  onClick?:
3571
3591
  GoogleChatV1WidgetMarkupOnClick;
3572
3592
  /**
3573
- * The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace
3574
- * Add-ons.
3593
+ * The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat
3594
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
3595
+ * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
3575
3596
  */
3576
3597
  topLabel?:
3577
3598
  string;
3578
3599
  }
3579
3600
  interface GoogleChatV1WidgetMarkupOnClick {
3580
- /** A form action will be triggered by this onclick if specified. */
3601
+ /** A form action is triggered by this `onclick` action if specified. */
3581
3602
  action?:
3582
3603
  GoogleChatV1WidgetMarkupFormAction;
3583
- /** This onclick triggers an open link action if specified. */
3604
+ /** This `onclick` action triggers an open link action if specified. */
3584
3605
  openLink?:
3585
3606
  GoogleChatV1WidgetMarkupOpenLink;
3586
3607
  }
@@ -3590,7 +3611,7 @@ declare namespace gapi.client {
3590
3611
  string;
3591
3612
  }
3592
3613
  interface GoogleChatV1WidgetMarkupTextButton {
3593
- /** The onclick action of the button. */
3614
+ /** The `onclick` action of the button. */
3594
3615
  onClick?:
3595
3616
  GoogleChatV1WidgetMarkupOnClick;
3596
3617
  /** The text of the button. */
@@ -5654,6 +5675,11 @@ declare namespace gapi.client {
5654
5675
  item?:
5655
5676
  PushItem;
5656
5677
  }
5678
+ interface QueryActivity {
5679
+ /** User input query to be logged/removed. */
5680
+ query?:
5681
+ string;
5682
+ }
5657
5683
  interface QueryCountByStatus {
5658
5684
  count?:
5659
5685
  string;
@@ -5924,6 +5950,17 @@ declare namespace gapi.client {
5924
5950
  references?:
5925
5951
  Reference[];
5926
5952
  }
5953
+ interface RemoveActivityRequest {
5954
+ /** Request options, such as the search application and clientId. */
5955
+ requestOptions?:
5956
+ RequestOptions;
5957
+ /** User Activity containing the data to be deleted. */
5958
+ userActivity?:
5959
+ UserActivity;
5960
+ }
5961
+ // tslint:disable-next-line:no-empty-interface
5962
+ interface RemoveActivityResponse {
5963
+ }
5927
5964
  interface RenameEvent {
5928
5965
  newName?:
5929
5966
  string;
@@ -6111,6 +6148,14 @@ declare namespace gapi.client {
6111
6148
  requestExtensions?:
6112
6149
  any;
6113
6150
  }
6151
+ interface SafeHtmlProto {
6152
+ /**
6153
+ * IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read
6154
+ * this message.
6155
+ */
6156
+ privateDoNotAccessOrElseSafeHtmlWrappedValue?:
6157
+ string;
6158
+ }
6114
6159
  interface SafeUrlProto {
6115
6160
  /**
6116
6161
  * IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read
@@ -6649,6 +6694,12 @@ declare namespace gapi.client {
6649
6694
  /** The suggested spelling of the query. */
6650
6695
  suggestedQuery?:
6651
6696
  string;
6697
+ /** The sanitized HTML representing the spell corrected query that can be used in the UI. This usually has language-specific tags to mark up parts of the query that are spell checked. */
6698
+ suggestedQueryHtml?:
6699
+ SafeHtmlProto;
6700
+ /** Suggestion triggered for the current query. */
6701
+ suggestionType?:
6702
+ string;
6652
6703
  }
6653
6704
  interface SquareProto {
6654
6705
  /**
@@ -7260,6 +7311,13 @@ declare namespace gapi.client {
7260
7311
  /** The metrics metadata of the Data Loss Prevention attachment scan. */
7261
7312
  dlpMetricsMetadata?:
7262
7313
  AppsDynamiteSharedDlpMetricsMetadata;
7314
+ /**
7315
+ * Message component search metadata for this upload_metadata (currently used for message highlighting and snippeting). For use by Search backend only; clients should get
7316
+ * upload_metadata search info from Annotation.component_search_info. This field is necessary because backend Message keeps UploadMetadata in a separate field. Upon converting from
7317
+ * backend message to frontend message, this field will be copied to Annotation.component_search_info while the corresponding UploadMetadata is converted into an Annotation.
7318
+ */
7319
+ internalOnlyComponentSearchInfo?:
7320
+ AppsDynamiteSharedMessageComponentSearchInfo;
7263
7321
  /** The timestamp of the most recent virus scan completed (in microseconds). */
7264
7322
  latestVirusScanTimestamp?:
7265
7323
  string;
@@ -7372,6 +7430,11 @@ declare namespace gapi.client {
7372
7430
  userProfileVisibility?:
7373
7431
  string;
7374
7432
  }
7433
+ interface UserActivity {
7434
+ /** Contains data which needs to be logged/removed. */
7435
+ queryActivity?:
7436
+ QueryActivity;
7437
+ }
7375
7438
  interface UserDisplayInfo {
7376
7439
  /** The avatar to show for this user */
7377
7440
  avatarUrl?:
@@ -9129,6 +9192,85 @@ declare namespace gapi.client {
9129
9192
  }): Request<ListQuerySourcesResponse>;
9130
9193
  }
9131
9194
  interface QueryResource {
9195
+ /**
9196
+ * Provides functionality to remove logged activity for a user. Currently to be used only for dynamite 1p clients **Note:** This API requires a standard end user account to execute. A
9197
+ * service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of
9198
+ * authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
9199
+ */
9200
+ removeActivity(request: {
9201
+ /** V1 error format. */
9202
+ "$.xgafv"?:
9203
+ string;
9204
+ /** OAuth access token. */
9205
+ access_token?:
9206
+ string;
9207
+ /** Data format for response. */
9208
+ alt?:
9209
+ string;
9210
+ /** JSONP */
9211
+ callback?:
9212
+ string;
9213
+ /** Selector specifying which fields to include in a partial response. */
9214
+ fields?:
9215
+ string;
9216
+ /** 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. */
9217
+ key?:
9218
+ string;
9219
+ /** OAuth 2.0 token for the current user. */
9220
+ oauth_token?:
9221
+ string;
9222
+ /** Returns response with indentations and line breaks. */
9223
+ prettyPrint?:
9224
+ boolean;
9225
+ /** 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. */
9226
+ quotaUser?:
9227
+ string;
9228
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9229
+ upload_protocol?:
9230
+ string;
9231
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9232
+ uploadType?:
9233
+ string;
9234
+ /** Request body */
9235
+ resource:
9236
+ RemoveActivityRequest;
9237
+ }): Request<{}>;
9238
+ removeActivity(request: {
9239
+ /** V1 error format. */
9240
+ "$.xgafv"?:
9241
+ string;
9242
+ /** OAuth access token. */
9243
+ access_token?:
9244
+ string;
9245
+ /** Data format for response. */
9246
+ alt?:
9247
+ string;
9248
+ /** JSONP */
9249
+ callback?:
9250
+ string;
9251
+ /** Selector specifying which fields to include in a partial response. */
9252
+ fields?:
9253
+ string;
9254
+ /** 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. */
9255
+ key?:
9256
+ string;
9257
+ /** OAuth 2.0 token for the current user. */
9258
+ oauth_token?:
9259
+ string;
9260
+ /** Returns response with indentations and line breaks. */
9261
+ prettyPrint?:
9262
+ boolean;
9263
+ /** 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. */
9264
+ quotaUser?:
9265
+ string;
9266
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9267
+ upload_protocol?:
9268
+ string;
9269
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9270
+ uploadType?:
9271
+ string;
9272
+ },
9273
+ body: RemoveActivityRequest): Request<{}>;
9132
9274
  /**
9133
9275
  * The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or
9134
9276
  * Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.cloudsearch-v1",
3
- "version": "0.0.20230510",
3
+ "version": "0.0.20230531",
4
4
  "description": "TypeScript typings for Cloud Search API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/readme.md CHANGED
@@ -100,6 +100,11 @@ Gets the latest state of a long-running operation. Clients can use this method t
100
100
  */
101
101
  await gapi.client.cloudsearch.operations.get({ name: "name", });
102
102
 
103
+ /*
104
+ Provides functionality to remove logged activity for a user. Currently to be used only for dynamite 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
105
+ */
106
+ await gapi.client.cloudsearch.query.removeActivity({ });
107
+
103
108
  /*
104
109
  The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
105
110
  */
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: 20230510
6
+ // Revision: 20230531
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -549,6 +549,27 @@ gapi.load('client', async () => {
549
549
  pageSize: 42,
550
550
  pageToken: "Test string",
551
551
  });
552
+ /**
553
+ * Provides functionality to remove logged activity for a user. Currently to be used only for dynamite 1p clients **Note:** This API requires a standard end user account to execute. A
554
+ * service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of
555
+ * authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
556
+ */
557
+ await gapi.client.cloudsearch.query.removeActivity({
558
+ }, {
559
+ requestOptions: {
560
+ debugOptions: {
561
+ enableDebugging: true,
562
+ },
563
+ languageCode: "Test string",
564
+ searchApplicationId: "Test string",
565
+ timeZone: "Test string",
566
+ },
567
+ userActivity: {
568
+ queryActivity: {
569
+ query: "Test string",
570
+ },
571
+ },
572
+ });
552
573
  /**
553
574
  * The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or
554
575
  * Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform