@maxim_mazurok/gapi.client.workspaceevents-v1 0.1.20260310 → 0.1.20260317
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.
- package/index.d.ts +64 -47
- package/package.json +1 -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://workspaceevents.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260317
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -86,7 +86,7 @@ declare namespace gapi.client {
|
|
|
86
86
|
/** protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message. */
|
|
87
87
|
metadata?: {[P in string]: any};
|
|
88
88
|
/** A role for the message. */
|
|
89
|
-
role?:
|
|
89
|
+
role?: 'ROLE_UNSPECIFIED' | 'ROLE_USER' | 'ROLE_AGENT';
|
|
90
90
|
/** The task id of the message. This is optional and if set, the message will be associated with the given task. */
|
|
91
91
|
taskId?: string;
|
|
92
92
|
}
|
|
@@ -184,9 +184,17 @@ declare namespace gapi.client {
|
|
|
184
184
|
/** Output only. If `true`, the subscription is in the process of being updated. */
|
|
185
185
|
reconciling?: boolean;
|
|
186
186
|
/** Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint. */
|
|
187
|
-
state?:
|
|
187
|
+
state?: 'STATE_UNSPECIFIED' | 'ACTIVE' | 'SUSPENDED' | 'DELETED';
|
|
188
188
|
/** Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the `ReactivateSubscription` method. */
|
|
189
|
-
suspensionReason?:
|
|
189
|
+
suspensionReason?:
|
|
190
|
+
| 'ERROR_TYPE_UNSPECIFIED'
|
|
191
|
+
| 'USER_SCOPE_REVOKED'
|
|
192
|
+
| 'RESOURCE_DELETED'
|
|
193
|
+
| 'USER_AUTHORIZATION_FAILURE'
|
|
194
|
+
| 'ENDPOINT_PERMISSION_DENIED'
|
|
195
|
+
| 'ENDPOINT_NOT_FOUND'
|
|
196
|
+
| 'ENDPOINT_RESOURCE_EXHAUSTED'
|
|
197
|
+
| 'OTHER';
|
|
190
198
|
/** Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error. */
|
|
191
199
|
targetResource?: string;
|
|
192
200
|
/** Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration. */
|
|
@@ -234,7 +242,16 @@ declare namespace gapi.client {
|
|
|
234
242
|
/** A message associated with the status. */
|
|
235
243
|
message?: Message;
|
|
236
244
|
/** The current state of this task */
|
|
237
|
-
state?:
|
|
245
|
+
state?:
|
|
246
|
+
| 'TASK_STATE_UNSPECIFIED'
|
|
247
|
+
| 'TASK_STATE_SUBMITTED'
|
|
248
|
+
| 'TASK_STATE_WORKING'
|
|
249
|
+
| 'TASK_STATE_COMPLETED'
|
|
250
|
+
| 'TASK_STATE_FAILED'
|
|
251
|
+
| 'TASK_STATE_CANCELLED'
|
|
252
|
+
| 'TASK_STATE_INPUT_REQUIRED'
|
|
253
|
+
| 'TASK_STATE_REJECTED'
|
|
254
|
+
| 'TASK_STATE_AUTH_REQUIRED';
|
|
238
255
|
/** Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z" */
|
|
239
256
|
timestamp?: string;
|
|
240
257
|
}
|
|
@@ -254,11 +271,11 @@ declare namespace gapi.client {
|
|
|
254
271
|
/** SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state. */
|
|
255
272
|
stream(request: {
|
|
256
273
|
/** V1 error format. */
|
|
257
|
-
'$.xgafv'?:
|
|
274
|
+
'$.xgafv'?: '1' | '2';
|
|
258
275
|
/** OAuth access token. */
|
|
259
276
|
access_token?: string;
|
|
260
277
|
/** Data format for response. */
|
|
261
|
-
alt?:
|
|
278
|
+
alt?: 'json' | 'media' | 'proto';
|
|
262
279
|
/** JSONP */
|
|
263
280
|
callback?: string;
|
|
264
281
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -281,11 +298,11 @@ declare namespace gapi.client {
|
|
|
281
298
|
stream(
|
|
282
299
|
request: {
|
|
283
300
|
/** V1 error format. */
|
|
284
|
-
'$.xgafv'?:
|
|
301
|
+
'$.xgafv'?: '1' | '2';
|
|
285
302
|
/** OAuth access token. */
|
|
286
303
|
access_token?: string;
|
|
287
304
|
/** Data format for response. */
|
|
288
|
-
alt?:
|
|
305
|
+
alt?: 'json' | 'media' | 'proto';
|
|
289
306
|
/** JSONP */
|
|
290
307
|
callback?: string;
|
|
291
308
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -310,11 +327,11 @@ declare namespace gapi.client {
|
|
|
310
327
|
/** 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. */
|
|
311
328
|
get(request?: {
|
|
312
329
|
/** V1 error format. */
|
|
313
|
-
'$.xgafv'?:
|
|
330
|
+
'$.xgafv'?: '1' | '2';
|
|
314
331
|
/** OAuth access token. */
|
|
315
332
|
access_token?: string;
|
|
316
333
|
/** Data format for response. */
|
|
317
|
-
alt?:
|
|
334
|
+
alt?: 'json' | 'media' | 'proto';
|
|
318
335
|
/** JSONP */
|
|
319
336
|
callback?: string;
|
|
320
337
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -339,11 +356,11 @@ declare namespace gapi.client {
|
|
|
339
356
|
/** Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
340
357
|
create(request: {
|
|
341
358
|
/** V1 error format. */
|
|
342
|
-
'$.xgafv'?:
|
|
359
|
+
'$.xgafv'?: '1' | '2';
|
|
343
360
|
/** OAuth access token. */
|
|
344
361
|
access_token?: string;
|
|
345
362
|
/** Data format for response. */
|
|
346
|
-
alt?:
|
|
363
|
+
alt?: 'json' | 'media' | 'proto';
|
|
347
364
|
/** JSONP */
|
|
348
365
|
callback?: string;
|
|
349
366
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -368,11 +385,11 @@ declare namespace gapi.client {
|
|
|
368
385
|
create(
|
|
369
386
|
request: {
|
|
370
387
|
/** V1 error format. */
|
|
371
|
-
'$.xgafv'?:
|
|
388
|
+
'$.xgafv'?: '1' | '2';
|
|
372
389
|
/** OAuth access token. */
|
|
373
390
|
access_token?: string;
|
|
374
391
|
/** Data format for response. */
|
|
375
|
-
alt?:
|
|
392
|
+
alt?: 'json' | 'media' | 'proto';
|
|
376
393
|
/** JSONP */
|
|
377
394
|
callback?: string;
|
|
378
395
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -397,13 +414,13 @@ declare namespace gapi.client {
|
|
|
397
414
|
/** Deletes a Google Workspace subscription. To learn how to use this method, see [Delete a Google Workspace subscription](https://developers.google.com/workspace/events/guides/delete-subscription). */
|
|
398
415
|
delete(request?: {
|
|
399
416
|
/** V1 error format. */
|
|
400
|
-
'$.xgafv'?:
|
|
417
|
+
'$.xgafv'?: '1' | '2';
|
|
401
418
|
/** OAuth access token. */
|
|
402
419
|
access_token?: string;
|
|
403
420
|
/** Optional. If set to `true` and the subscription isn't found, the request succeeds but doesn't delete the subscription. */
|
|
404
421
|
allowMissing?: boolean;
|
|
405
422
|
/** Data format for response. */
|
|
406
|
-
alt?:
|
|
423
|
+
alt?: 'json' | 'media' | 'proto';
|
|
407
424
|
/** JSONP */
|
|
408
425
|
callback?: string;
|
|
409
426
|
/** Optional. Etag of the subscription. If present, it must match with the server's etag. Otherwise, request fails with the status `ABORTED`. */
|
|
@@ -430,11 +447,11 @@ declare namespace gapi.client {
|
|
|
430
447
|
/** Gets details about a Google Workspace subscription. To learn how to use this method, see [Get details about a Google Workspace subscription](https://developers.google.com/workspace/events/guides/get-subscription). */
|
|
431
448
|
get(request?: {
|
|
432
449
|
/** V1 error format. */
|
|
433
|
-
'$.xgafv'?:
|
|
450
|
+
'$.xgafv'?: '1' | '2';
|
|
434
451
|
/** OAuth access token. */
|
|
435
452
|
access_token?: string;
|
|
436
453
|
/** Data format for response. */
|
|
437
|
-
alt?:
|
|
454
|
+
alt?: 'json' | 'media' | 'proto';
|
|
438
455
|
/** JSONP */
|
|
439
456
|
callback?: string;
|
|
440
457
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -457,11 +474,11 @@ declare namespace gapi.client {
|
|
|
457
474
|
/** Lists Google Workspace subscriptions. To learn how to use this method, see [List Google Workspace subscriptions](https://developers.google.com/workspace/events/guides/list-subscriptions). */
|
|
458
475
|
list(request?: {
|
|
459
476
|
/** V1 error format. */
|
|
460
|
-
'$.xgafv'?:
|
|
477
|
+
'$.xgafv'?: '1' | '2';
|
|
461
478
|
/** OAuth access token. */
|
|
462
479
|
access_token?: string;
|
|
463
480
|
/** Data format for response. */
|
|
464
|
-
alt?:
|
|
481
|
+
alt?: 'json' | 'media' | 'proto';
|
|
465
482
|
/** JSONP */
|
|
466
483
|
callback?: string;
|
|
467
484
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -488,11 +505,11 @@ declare namespace gapi.client {
|
|
|
488
505
|
/** Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
489
506
|
patch(request: {
|
|
490
507
|
/** V1 error format. */
|
|
491
|
-
'$.xgafv'?:
|
|
508
|
+
'$.xgafv'?: '1' | '2';
|
|
492
509
|
/** OAuth access token. */
|
|
493
510
|
access_token?: string;
|
|
494
511
|
/** Data format for response. */
|
|
495
|
-
alt?:
|
|
512
|
+
alt?: 'json' | 'media' | 'proto';
|
|
496
513
|
/** JSONP */
|
|
497
514
|
callback?: string;
|
|
498
515
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -521,11 +538,11 @@ declare namespace gapi.client {
|
|
|
521
538
|
patch(
|
|
522
539
|
request: {
|
|
523
540
|
/** V1 error format. */
|
|
524
|
-
'$.xgafv'?:
|
|
541
|
+
'$.xgafv'?: '1' | '2';
|
|
525
542
|
/** OAuth access token. */
|
|
526
543
|
access_token?: string;
|
|
527
544
|
/** Data format for response. */
|
|
528
|
-
alt?:
|
|
545
|
+
alt?: 'json' | 'media' | 'proto';
|
|
529
546
|
/** JSONP */
|
|
530
547
|
callback?: string;
|
|
531
548
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -554,11 +571,11 @@ declare namespace gapi.client {
|
|
|
554
571
|
/** Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
555
572
|
reactivate(request: {
|
|
556
573
|
/** V1 error format. */
|
|
557
|
-
'$.xgafv'?:
|
|
574
|
+
'$.xgafv'?: '1' | '2';
|
|
558
575
|
/** OAuth access token. */
|
|
559
576
|
access_token?: string;
|
|
560
577
|
/** Data format for response. */
|
|
561
|
-
alt?:
|
|
578
|
+
alt?: 'json' | 'media' | 'proto';
|
|
562
579
|
/** JSONP */
|
|
563
580
|
callback?: string;
|
|
564
581
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -583,11 +600,11 @@ declare namespace gapi.client {
|
|
|
583
600
|
reactivate(
|
|
584
601
|
request: {
|
|
585
602
|
/** V1 error format. */
|
|
586
|
-
'$.xgafv'?:
|
|
603
|
+
'$.xgafv'?: '1' | '2';
|
|
587
604
|
/** OAuth access token. */
|
|
588
605
|
access_token?: string;
|
|
589
606
|
/** Data format for response. */
|
|
590
|
-
alt?:
|
|
607
|
+
alt?: 'json' | 'media' | 'proto';
|
|
591
608
|
/** JSONP */
|
|
592
609
|
callback?: string;
|
|
593
610
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -614,11 +631,11 @@ declare namespace gapi.client {
|
|
|
614
631
|
/** Set a push notification config for a task. */
|
|
615
632
|
create(request: {
|
|
616
633
|
/** V1 error format. */
|
|
617
|
-
'$.xgafv'?:
|
|
634
|
+
'$.xgafv'?: '1' | '2';
|
|
618
635
|
/** OAuth access token. */
|
|
619
636
|
access_token?: string;
|
|
620
637
|
/** Data format for response. */
|
|
621
|
-
alt?:
|
|
638
|
+
alt?: 'json' | 'media' | 'proto';
|
|
622
639
|
/** JSONP */
|
|
623
640
|
callback?: string;
|
|
624
641
|
/** Required. The ID for the new config. */
|
|
@@ -647,11 +664,11 @@ declare namespace gapi.client {
|
|
|
647
664
|
create(
|
|
648
665
|
request: {
|
|
649
666
|
/** V1 error format. */
|
|
650
|
-
'$.xgafv'?:
|
|
667
|
+
'$.xgafv'?: '1' | '2';
|
|
651
668
|
/** OAuth access token. */
|
|
652
669
|
access_token?: string;
|
|
653
670
|
/** Data format for response. */
|
|
654
|
-
alt?:
|
|
671
|
+
alt?: 'json' | 'media' | 'proto';
|
|
655
672
|
/** JSONP */
|
|
656
673
|
callback?: string;
|
|
657
674
|
/** Required. The ID for the new config. */
|
|
@@ -680,11 +697,11 @@ declare namespace gapi.client {
|
|
|
680
697
|
/** Delete a push notification config for a task. */
|
|
681
698
|
delete(request?: {
|
|
682
699
|
/** V1 error format. */
|
|
683
|
-
'$.xgafv'?:
|
|
700
|
+
'$.xgafv'?: '1' | '2';
|
|
684
701
|
/** OAuth access token. */
|
|
685
702
|
access_token?: string;
|
|
686
703
|
/** Data format for response. */
|
|
687
|
-
alt?:
|
|
704
|
+
alt?: 'json' | 'media' | 'proto';
|
|
688
705
|
/** JSONP */
|
|
689
706
|
callback?: string;
|
|
690
707
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -709,11 +726,11 @@ declare namespace gapi.client {
|
|
|
709
726
|
/** Get a push notification config for a task. */
|
|
710
727
|
get(request?: {
|
|
711
728
|
/** V1 error format. */
|
|
712
|
-
'$.xgafv'?:
|
|
729
|
+
'$.xgafv'?: '1' | '2';
|
|
713
730
|
/** OAuth access token. */
|
|
714
731
|
access_token?: string;
|
|
715
732
|
/** Data format for response. */
|
|
716
|
-
alt?:
|
|
733
|
+
alt?: 'json' | 'media' | 'proto';
|
|
717
734
|
/** JSONP */
|
|
718
735
|
callback?: string;
|
|
719
736
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -738,11 +755,11 @@ declare namespace gapi.client {
|
|
|
738
755
|
/** Get a list of push notifications configured for a task. */
|
|
739
756
|
list(request?: {
|
|
740
757
|
/** V1 error format. */
|
|
741
|
-
'$.xgafv'?:
|
|
758
|
+
'$.xgafv'?: '1' | '2';
|
|
742
759
|
/** OAuth access token. */
|
|
743
760
|
access_token?: string;
|
|
744
761
|
/** Data format for response. */
|
|
745
|
-
alt?:
|
|
762
|
+
alt?: 'json' | 'media' | 'proto';
|
|
746
763
|
/** JSONP */
|
|
747
764
|
callback?: string;
|
|
748
765
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -773,11 +790,11 @@ declare namespace gapi.client {
|
|
|
773
790
|
/** Cancel a task from the agent. If supported one should expect no more task updates for the task. */
|
|
774
791
|
cancel(request: {
|
|
775
792
|
/** V1 error format. */
|
|
776
|
-
'$.xgafv'?:
|
|
793
|
+
'$.xgafv'?: '1' | '2';
|
|
777
794
|
/** OAuth access token. */
|
|
778
795
|
access_token?: string;
|
|
779
796
|
/** Data format for response. */
|
|
780
|
-
alt?:
|
|
797
|
+
alt?: 'json' | 'media' | 'proto';
|
|
781
798
|
/** JSONP */
|
|
782
799
|
callback?: string;
|
|
783
800
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -802,11 +819,11 @@ declare namespace gapi.client {
|
|
|
802
819
|
cancel(
|
|
803
820
|
request: {
|
|
804
821
|
/** V1 error format. */
|
|
805
|
-
'$.xgafv'?:
|
|
822
|
+
'$.xgafv'?: '1' | '2';
|
|
806
823
|
/** OAuth access token. */
|
|
807
824
|
access_token?: string;
|
|
808
825
|
/** Data format for response. */
|
|
809
|
-
alt?:
|
|
826
|
+
alt?: 'json' | 'media' | 'proto';
|
|
810
827
|
/** JSONP */
|
|
811
828
|
callback?: string;
|
|
812
829
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -831,11 +848,11 @@ declare namespace gapi.client {
|
|
|
831
848
|
/** Get the current state of a task from the agent. */
|
|
832
849
|
get(request?: {
|
|
833
850
|
/** V1 error format. */
|
|
834
|
-
'$.xgafv'?:
|
|
851
|
+
'$.xgafv'?: '1' | '2';
|
|
835
852
|
/** OAuth access token. */
|
|
836
853
|
access_token?: string;
|
|
837
854
|
/** Data format for response. */
|
|
838
|
-
alt?:
|
|
855
|
+
alt?: 'json' | 'media' | 'proto';
|
|
839
856
|
/** JSONP */
|
|
840
857
|
callback?: string;
|
|
841
858
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -862,11 +879,11 @@ declare namespace gapi.client {
|
|
|
862
879
|
/** TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream. */
|
|
863
880
|
subscribe(request?: {
|
|
864
881
|
/** V1 error format. */
|
|
865
|
-
'$.xgafv'?:
|
|
882
|
+
'$.xgafv'?: '1' | '2';
|
|
866
883
|
/** OAuth access token. */
|
|
867
884
|
access_token?: string;
|
|
868
885
|
/** Data format for response. */
|
|
869
|
-
alt?:
|
|
886
|
+
alt?: 'json' | 'media' | 'proto';
|
|
870
887
|
/** JSONP */
|
|
871
888
|
callback?: string;
|
|
872
889
|
/** Selector specifying which fields to include in a partial response. */
|