@maxim_mazurok/gapi.client.pubsub-v1beta2 0.1.20260310 → 0.1.20260526
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 +55 -55
- package/package.json +1 -1
- package/readme.md +12 -0
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://pubsub.googleapis.com/$discovery/rest?version=v1beta2
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260526
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -163,11 +163,11 @@ declare namespace gapi.client {
|
|
|
163
163
|
/** Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error. */
|
|
164
164
|
acknowledge(request: {
|
|
165
165
|
/** V1 error format. */
|
|
166
|
-
'$.xgafv'?:
|
|
166
|
+
'$.xgafv'?: '1' | '2';
|
|
167
167
|
/** OAuth access token. */
|
|
168
168
|
access_token?: string;
|
|
169
169
|
/** Data format for response. */
|
|
170
|
-
alt?:
|
|
170
|
+
alt?: 'json' | 'media' | 'proto';
|
|
171
171
|
/** JSONP */
|
|
172
172
|
callback?: string;
|
|
173
173
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -192,11 +192,11 @@ declare namespace gapi.client {
|
|
|
192
192
|
acknowledge(
|
|
193
193
|
request: {
|
|
194
194
|
/** V1 error format. */
|
|
195
|
-
'$.xgafv'?:
|
|
195
|
+
'$.xgafv'?: '1' | '2';
|
|
196
196
|
/** OAuth access token. */
|
|
197
197
|
access_token?: string;
|
|
198
198
|
/** Data format for response. */
|
|
199
|
-
alt?:
|
|
199
|
+
alt?: 'json' | 'media' | 'proto';
|
|
200
200
|
/** JSONP */
|
|
201
201
|
callback?: string;
|
|
202
202
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -221,11 +221,11 @@ declare namespace gapi.client {
|
|
|
221
221
|
/** Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name. */
|
|
222
222
|
create(request: {
|
|
223
223
|
/** V1 error format. */
|
|
224
|
-
'$.xgafv'?:
|
|
224
|
+
'$.xgafv'?: '1' | '2';
|
|
225
225
|
/** OAuth access token. */
|
|
226
226
|
access_token?: string;
|
|
227
227
|
/** Data format for response. */
|
|
228
|
-
alt?:
|
|
228
|
+
alt?: 'json' | 'media' | 'proto';
|
|
229
229
|
/** JSONP */
|
|
230
230
|
callback?: string;
|
|
231
231
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -250,11 +250,11 @@ declare namespace gapi.client {
|
|
|
250
250
|
create(
|
|
251
251
|
request: {
|
|
252
252
|
/** V1 error format. */
|
|
253
|
-
'$.xgafv'?:
|
|
253
|
+
'$.xgafv'?: '1' | '2';
|
|
254
254
|
/** OAuth access token. */
|
|
255
255
|
access_token?: string;
|
|
256
256
|
/** Data format for response. */
|
|
257
|
-
alt?:
|
|
257
|
+
alt?: 'json' | 'media' | 'proto';
|
|
258
258
|
/** JSONP */
|
|
259
259
|
callback?: string;
|
|
260
260
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -279,11 +279,11 @@ declare namespace gapi.client {
|
|
|
279
279
|
/** Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified. */
|
|
280
280
|
delete(request?: {
|
|
281
281
|
/** V1 error format. */
|
|
282
|
-
'$.xgafv'?:
|
|
282
|
+
'$.xgafv'?: '1' | '2';
|
|
283
283
|
/** OAuth access token. */
|
|
284
284
|
access_token?: string;
|
|
285
285
|
/** Data format for response. */
|
|
286
|
-
alt?:
|
|
286
|
+
alt?: 'json' | 'media' | 'proto';
|
|
287
287
|
/** JSONP */
|
|
288
288
|
callback?: string;
|
|
289
289
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -306,11 +306,11 @@ declare namespace gapi.client {
|
|
|
306
306
|
/** Gets the configuration details of a subscription. */
|
|
307
307
|
get(request?: {
|
|
308
308
|
/** V1 error format. */
|
|
309
|
-
'$.xgafv'?:
|
|
309
|
+
'$.xgafv'?: '1' | '2';
|
|
310
310
|
/** OAuth access token. */
|
|
311
311
|
access_token?: string;
|
|
312
312
|
/** Data format for response. */
|
|
313
|
-
alt?:
|
|
313
|
+
alt?: 'json' | 'media' | 'proto';
|
|
314
314
|
/** JSONP */
|
|
315
315
|
callback?: string;
|
|
316
316
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -333,11 +333,11 @@ declare namespace gapi.client {
|
|
|
333
333
|
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
334
334
|
getIamPolicy(request?: {
|
|
335
335
|
/** V1 error format. */
|
|
336
|
-
'$.xgafv'?:
|
|
336
|
+
'$.xgafv'?: '1' | '2';
|
|
337
337
|
/** OAuth access token. */
|
|
338
338
|
access_token?: string;
|
|
339
339
|
/** Data format for response. */
|
|
340
|
-
alt?:
|
|
340
|
+
alt?: 'json' | 'media' | 'proto';
|
|
341
341
|
/** JSONP */
|
|
342
342
|
callback?: string;
|
|
343
343
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -362,11 +362,11 @@ declare namespace gapi.client {
|
|
|
362
362
|
/** Lists matching subscriptions. */
|
|
363
363
|
list(request?: {
|
|
364
364
|
/** V1 error format. */
|
|
365
|
-
'$.xgafv'?:
|
|
365
|
+
'$.xgafv'?: '1' | '2';
|
|
366
366
|
/** OAuth access token. */
|
|
367
367
|
access_token?: string;
|
|
368
368
|
/** Data format for response. */
|
|
369
|
-
alt?:
|
|
369
|
+
alt?: 'json' | 'media' | 'proto';
|
|
370
370
|
/** JSONP */
|
|
371
371
|
callback?: string;
|
|
372
372
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -393,11 +393,11 @@ declare namespace gapi.client {
|
|
|
393
393
|
/** Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages. */
|
|
394
394
|
modifyAckDeadline(request: {
|
|
395
395
|
/** V1 error format. */
|
|
396
|
-
'$.xgafv'?:
|
|
396
|
+
'$.xgafv'?: '1' | '2';
|
|
397
397
|
/** OAuth access token. */
|
|
398
398
|
access_token?: string;
|
|
399
399
|
/** Data format for response. */
|
|
400
|
-
alt?:
|
|
400
|
+
alt?: 'json' | 'media' | 'proto';
|
|
401
401
|
/** JSONP */
|
|
402
402
|
callback?: string;
|
|
403
403
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -422,11 +422,11 @@ declare namespace gapi.client {
|
|
|
422
422
|
modifyAckDeadline(
|
|
423
423
|
request: {
|
|
424
424
|
/** V1 error format. */
|
|
425
|
-
'$.xgafv'?:
|
|
425
|
+
'$.xgafv'?: '1' | '2';
|
|
426
426
|
/** OAuth access token. */
|
|
427
427
|
access_token?: string;
|
|
428
428
|
/** Data format for response. */
|
|
429
|
-
alt?:
|
|
429
|
+
alt?: 'json' | 'media' | 'proto';
|
|
430
430
|
/** JSONP */
|
|
431
431
|
callback?: string;
|
|
432
432
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -451,11 +451,11 @@ declare namespace gapi.client {
|
|
|
451
451
|
/** Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`. */
|
|
452
452
|
modifyPushConfig(request: {
|
|
453
453
|
/** V1 error format. */
|
|
454
|
-
'$.xgafv'?:
|
|
454
|
+
'$.xgafv'?: '1' | '2';
|
|
455
455
|
/** OAuth access token. */
|
|
456
456
|
access_token?: string;
|
|
457
457
|
/** Data format for response. */
|
|
458
|
-
alt?:
|
|
458
|
+
alt?: 'json' | 'media' | 'proto';
|
|
459
459
|
/** JSONP */
|
|
460
460
|
callback?: string;
|
|
461
461
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -480,11 +480,11 @@ declare namespace gapi.client {
|
|
|
480
480
|
modifyPushConfig(
|
|
481
481
|
request: {
|
|
482
482
|
/** V1 error format. */
|
|
483
|
-
'$.xgafv'?:
|
|
483
|
+
'$.xgafv'?: '1' | '2';
|
|
484
484
|
/** OAuth access token. */
|
|
485
485
|
access_token?: string;
|
|
486
486
|
/** Data format for response. */
|
|
487
|
-
alt?:
|
|
487
|
+
alt?: 'json' | 'media' | 'proto';
|
|
488
488
|
/** JSONP */
|
|
489
489
|
callback?: string;
|
|
490
490
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -509,11 +509,11 @@ declare namespace gapi.client {
|
|
|
509
509
|
/** Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription. */
|
|
510
510
|
pull(request: {
|
|
511
511
|
/** V1 error format. */
|
|
512
|
-
'$.xgafv'?:
|
|
512
|
+
'$.xgafv'?: '1' | '2';
|
|
513
513
|
/** OAuth access token. */
|
|
514
514
|
access_token?: string;
|
|
515
515
|
/** Data format for response. */
|
|
516
|
-
alt?:
|
|
516
|
+
alt?: 'json' | 'media' | 'proto';
|
|
517
517
|
/** JSONP */
|
|
518
518
|
callback?: string;
|
|
519
519
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -538,11 +538,11 @@ declare namespace gapi.client {
|
|
|
538
538
|
pull(
|
|
539
539
|
request: {
|
|
540
540
|
/** V1 error format. */
|
|
541
|
-
'$.xgafv'?:
|
|
541
|
+
'$.xgafv'?: '1' | '2';
|
|
542
542
|
/** OAuth access token. */
|
|
543
543
|
access_token?: string;
|
|
544
544
|
/** Data format for response. */
|
|
545
|
-
alt?:
|
|
545
|
+
alt?: 'json' | 'media' | 'proto';
|
|
546
546
|
/** JSONP */
|
|
547
547
|
callback?: string;
|
|
548
548
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -568,11 +568,11 @@ declare namespace gapi.client {
|
|
|
568
568
|
setIamPolicy(
|
|
569
569
|
request: {
|
|
570
570
|
/** V1 error format. */
|
|
571
|
-
'$.xgafv'?:
|
|
571
|
+
'$.xgafv'?: '1' | '2';
|
|
572
572
|
/** OAuth access token. */
|
|
573
573
|
access_token?: string;
|
|
574
574
|
/** Data format for response. */
|
|
575
|
-
alt?:
|
|
575
|
+
alt?: 'json' | 'media' | 'proto';
|
|
576
576
|
/** JSONP */
|
|
577
577
|
callback?: string;
|
|
578
578
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -598,11 +598,11 @@ declare namespace gapi.client {
|
|
|
598
598
|
testIamPermissions(
|
|
599
599
|
request: {
|
|
600
600
|
/** V1 error format. */
|
|
601
|
-
'$.xgafv'?:
|
|
601
|
+
'$.xgafv'?: '1' | '2';
|
|
602
602
|
/** OAuth access token. */
|
|
603
603
|
access_token?: string;
|
|
604
604
|
/** Data format for response. */
|
|
605
|
-
alt?:
|
|
605
|
+
alt?: 'json' | 'media' | 'proto';
|
|
606
606
|
/** JSONP */
|
|
607
607
|
callback?: string;
|
|
608
608
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -629,11 +629,11 @@ declare namespace gapi.client {
|
|
|
629
629
|
/** Lists the name of the subscriptions for this topic. */
|
|
630
630
|
list(request?: {
|
|
631
631
|
/** V1 error format. */
|
|
632
|
-
'$.xgafv'?:
|
|
632
|
+
'$.xgafv'?: '1' | '2';
|
|
633
633
|
/** OAuth access token. */
|
|
634
634
|
access_token?: string;
|
|
635
635
|
/** Data format for response. */
|
|
636
|
-
alt?:
|
|
636
|
+
alt?: 'json' | 'media' | 'proto';
|
|
637
637
|
/** JSONP */
|
|
638
638
|
callback?: string;
|
|
639
639
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -662,11 +662,11 @@ declare namespace gapi.client {
|
|
|
662
662
|
/** Creates the given topic with the given name. */
|
|
663
663
|
create(request: {
|
|
664
664
|
/** V1 error format. */
|
|
665
|
-
'$.xgafv'?:
|
|
665
|
+
'$.xgafv'?: '1' | '2';
|
|
666
666
|
/** OAuth access token. */
|
|
667
667
|
access_token?: string;
|
|
668
668
|
/** Data format for response. */
|
|
669
|
-
alt?:
|
|
669
|
+
alt?: 'json' | 'media' | 'proto';
|
|
670
670
|
/** JSONP */
|
|
671
671
|
callback?: string;
|
|
672
672
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -691,11 +691,11 @@ declare namespace gapi.client {
|
|
|
691
691
|
create(
|
|
692
692
|
request: {
|
|
693
693
|
/** V1 error format. */
|
|
694
|
-
'$.xgafv'?:
|
|
694
|
+
'$.xgafv'?: '1' | '2';
|
|
695
695
|
/** OAuth access token. */
|
|
696
696
|
access_token?: string;
|
|
697
697
|
/** Data format for response. */
|
|
698
|
-
alt?:
|
|
698
|
+
alt?: 'json' | 'media' | 'proto';
|
|
699
699
|
/** JSONP */
|
|
700
700
|
callback?: string;
|
|
701
701
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -720,11 +720,11 @@ declare namespace gapi.client {
|
|
|
720
720
|
/** Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`. */
|
|
721
721
|
delete(request?: {
|
|
722
722
|
/** V1 error format. */
|
|
723
|
-
'$.xgafv'?:
|
|
723
|
+
'$.xgafv'?: '1' | '2';
|
|
724
724
|
/** OAuth access token. */
|
|
725
725
|
access_token?: string;
|
|
726
726
|
/** Data format for response. */
|
|
727
|
-
alt?:
|
|
727
|
+
alt?: 'json' | 'media' | 'proto';
|
|
728
728
|
/** JSONP */
|
|
729
729
|
callback?: string;
|
|
730
730
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -747,11 +747,11 @@ declare namespace gapi.client {
|
|
|
747
747
|
/** Gets the configuration of a topic. */
|
|
748
748
|
get(request?: {
|
|
749
749
|
/** V1 error format. */
|
|
750
|
-
'$.xgafv'?:
|
|
750
|
+
'$.xgafv'?: '1' | '2';
|
|
751
751
|
/** OAuth access token. */
|
|
752
752
|
access_token?: string;
|
|
753
753
|
/** Data format for response. */
|
|
754
|
-
alt?:
|
|
754
|
+
alt?: 'json' | 'media' | 'proto';
|
|
755
755
|
/** JSONP */
|
|
756
756
|
callback?: string;
|
|
757
757
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -774,11 +774,11 @@ declare namespace gapi.client {
|
|
|
774
774
|
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
775
775
|
getIamPolicy(request?: {
|
|
776
776
|
/** V1 error format. */
|
|
777
|
-
'$.xgafv'?:
|
|
777
|
+
'$.xgafv'?: '1' | '2';
|
|
778
778
|
/** OAuth access token. */
|
|
779
779
|
access_token?: string;
|
|
780
780
|
/** Data format for response. */
|
|
781
|
-
alt?:
|
|
781
|
+
alt?: 'json' | 'media' | 'proto';
|
|
782
782
|
/** JSONP */
|
|
783
783
|
callback?: string;
|
|
784
784
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -803,11 +803,11 @@ declare namespace gapi.client {
|
|
|
803
803
|
/** Lists matching topics. */
|
|
804
804
|
list(request?: {
|
|
805
805
|
/** V1 error format. */
|
|
806
|
-
'$.xgafv'?:
|
|
806
|
+
'$.xgafv'?: '1' | '2';
|
|
807
807
|
/** OAuth access token. */
|
|
808
808
|
access_token?: string;
|
|
809
809
|
/** Data format for response. */
|
|
810
|
-
alt?:
|
|
810
|
+
alt?: 'json' | 'media' | 'proto';
|
|
811
811
|
/** JSONP */
|
|
812
812
|
callback?: string;
|
|
813
813
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -834,11 +834,11 @@ declare namespace gapi.client {
|
|
|
834
834
|
/** Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute. */
|
|
835
835
|
publish(request: {
|
|
836
836
|
/** V1 error format. */
|
|
837
|
-
'$.xgafv'?:
|
|
837
|
+
'$.xgafv'?: '1' | '2';
|
|
838
838
|
/** OAuth access token. */
|
|
839
839
|
access_token?: string;
|
|
840
840
|
/** Data format for response. */
|
|
841
|
-
alt?:
|
|
841
|
+
alt?: 'json' | 'media' | 'proto';
|
|
842
842
|
/** JSONP */
|
|
843
843
|
callback?: string;
|
|
844
844
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -863,11 +863,11 @@ declare namespace gapi.client {
|
|
|
863
863
|
publish(
|
|
864
864
|
request: {
|
|
865
865
|
/** V1 error format. */
|
|
866
|
-
'$.xgafv'?:
|
|
866
|
+
'$.xgafv'?: '1' | '2';
|
|
867
867
|
/** OAuth access token. */
|
|
868
868
|
access_token?: string;
|
|
869
869
|
/** Data format for response. */
|
|
870
|
-
alt?:
|
|
870
|
+
alt?: 'json' | 'media' | 'proto';
|
|
871
871
|
/** JSONP */
|
|
872
872
|
callback?: string;
|
|
873
873
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -893,11 +893,11 @@ declare namespace gapi.client {
|
|
|
893
893
|
setIamPolicy(
|
|
894
894
|
request: {
|
|
895
895
|
/** V1 error format. */
|
|
896
|
-
'$.xgafv'?:
|
|
896
|
+
'$.xgafv'?: '1' | '2';
|
|
897
897
|
/** OAuth access token. */
|
|
898
898
|
access_token?: string;
|
|
899
899
|
/** Data format for response. */
|
|
900
|
-
alt?:
|
|
900
|
+
alt?: 'json' | 'media' | 'proto';
|
|
901
901
|
/** JSONP */
|
|
902
902
|
callback?: string;
|
|
903
903
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -923,11 +923,11 @@ declare namespace gapi.client {
|
|
|
923
923
|
testIamPermissions(
|
|
924
924
|
request: {
|
|
925
925
|
/** V1 error format. */
|
|
926
|
-
'$.xgafv'?:
|
|
926
|
+
'$.xgafv'?: '1' | '2';
|
|
927
927
|
/** OAuth access token. */
|
|
928
928
|
access_token?: string;
|
|
929
929
|
/** Data format for response. */
|
|
930
|
-
alt?:
|
|
930
|
+
alt?: 'json' | 'media' | 'proto';
|
|
931
931
|
/** JSONP */
|
|
932
932
|
callback?: string;
|
|
933
933
|
/** Selector specifying which fields to include in a partial response. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,18 @@ Install typings for Cloud Pub/Sub API:
|
|
|
11
11
|
npm install @types/gapi.client.pubsub-v1beta2 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": ["gapi", "gapi.auth2", "gapi.client", "gapi.client.pubsub-v1beta2"]
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
14
26
|
## Usage
|
|
15
27
|
|
|
16
28
|
You need to initialize Google API client in your code:
|