@maxim_mazurok/gapi.client.pubsub-v1beta1a 0.1.20260310 → 0.1.20260602
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 +49 -49
- package/package.json +1 -1
- package/readme.md +17 -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=v1beta1a
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260602
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -149,11 +149,11 @@ declare namespace gapi.client {
|
|
|
149
149
|
/** Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription. Acknowledging a message whose Ack deadline has expired may succeed, but the message could have been already redelivered. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull. */
|
|
150
150
|
acknowledge(request: {
|
|
151
151
|
/** V1 error format. */
|
|
152
|
-
'$.xgafv'?:
|
|
152
|
+
'$.xgafv'?: '1' | '2';
|
|
153
153
|
/** OAuth access token. */
|
|
154
154
|
access_token?: string;
|
|
155
155
|
/** Data format for response. */
|
|
156
|
-
alt?:
|
|
156
|
+
alt?: 'json' | 'media' | 'proto';
|
|
157
157
|
/** JSONP */
|
|
158
158
|
callback?: string;
|
|
159
159
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -176,11 +176,11 @@ declare namespace gapi.client {
|
|
|
176
176
|
acknowledge(
|
|
177
177
|
request: {
|
|
178
178
|
/** V1 error format. */
|
|
179
|
-
'$.xgafv'?:
|
|
179
|
+
'$.xgafv'?: '1' | '2';
|
|
180
180
|
/** OAuth access token. */
|
|
181
181
|
access_token?: string;
|
|
182
182
|
/** Data format for response. */
|
|
183
|
-
alt?:
|
|
183
|
+
alt?: 'json' | 'media' | 'proto';
|
|
184
184
|
/** JSONP */
|
|
185
185
|
callback?: string;
|
|
186
186
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -203,11 +203,11 @@ declare namespace gapi.client {
|
|
|
203
203
|
/** Creates a subscription on a given topic for a given subscriber. 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. */
|
|
204
204
|
create(request: {
|
|
205
205
|
/** V1 error format. */
|
|
206
|
-
'$.xgafv'?:
|
|
206
|
+
'$.xgafv'?: '1' | '2';
|
|
207
207
|
/** OAuth access token. */
|
|
208
208
|
access_token?: string;
|
|
209
209
|
/** Data format for response. */
|
|
210
|
-
alt?:
|
|
210
|
+
alt?: 'json' | 'media' | 'proto';
|
|
211
211
|
/** JSONP */
|
|
212
212
|
callback?: string;
|
|
213
213
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -230,11 +230,11 @@ declare namespace gapi.client {
|
|
|
230
230
|
create(
|
|
231
231
|
request: {
|
|
232
232
|
/** V1 error format. */
|
|
233
|
-
'$.xgafv'?:
|
|
233
|
+
'$.xgafv'?: '1' | '2';
|
|
234
234
|
/** OAuth access token. */
|
|
235
235
|
access_token?: string;
|
|
236
236
|
/** Data format for response. */
|
|
237
|
-
alt?:
|
|
237
|
+
alt?: 'json' | 'media' | 'proto';
|
|
238
238
|
/** JSONP */
|
|
239
239
|
callback?: string;
|
|
240
240
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -257,11 +257,11 @@ declare namespace gapi.client {
|
|
|
257
257
|
/** Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. */
|
|
258
258
|
delete(request?: {
|
|
259
259
|
/** V1 error format. */
|
|
260
|
-
'$.xgafv'?:
|
|
260
|
+
'$.xgafv'?: '1' | '2';
|
|
261
261
|
/** OAuth access token. */
|
|
262
262
|
access_token?: string;
|
|
263
263
|
/** Data format for response. */
|
|
264
|
-
alt?:
|
|
264
|
+
alt?: 'json' | 'media' | 'proto';
|
|
265
265
|
/** JSONP */
|
|
266
266
|
callback?: string;
|
|
267
267
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -284,11 +284,11 @@ declare namespace gapi.client {
|
|
|
284
284
|
/** Gets the configuration details of a subscription. */
|
|
285
285
|
get(request?: {
|
|
286
286
|
/** V1 error format. */
|
|
287
|
-
'$.xgafv'?:
|
|
287
|
+
'$.xgafv'?: '1' | '2';
|
|
288
288
|
/** OAuth access token. */
|
|
289
289
|
access_token?: string;
|
|
290
290
|
/** Data format for response. */
|
|
291
|
-
alt?:
|
|
291
|
+
alt?: 'json' | 'media' | 'proto';
|
|
292
292
|
/** JSONP */
|
|
293
293
|
callback?: string;
|
|
294
294
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -311,11 +311,11 @@ declare namespace gapi.client {
|
|
|
311
311
|
/** Lists matching subscriptions. */
|
|
312
312
|
list(request?: {
|
|
313
313
|
/** V1 error format. */
|
|
314
|
-
'$.xgafv'?:
|
|
314
|
+
'$.xgafv'?: '1' | '2';
|
|
315
315
|
/** OAuth access token. */
|
|
316
316
|
access_token?: string;
|
|
317
317
|
/** Data format for response. */
|
|
318
|
-
alt?:
|
|
318
|
+
alt?: 'json' | 'media' | 'proto';
|
|
319
319
|
/** JSONP */
|
|
320
320
|
callback?: string;
|
|
321
321
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -342,11 +342,11 @@ declare namespace gapi.client {
|
|
|
342
342
|
/** Modifies the Ack deadline for a message received from a pull request. */
|
|
343
343
|
modifyAckDeadline(request: {
|
|
344
344
|
/** V1 error format. */
|
|
345
|
-
'$.xgafv'?:
|
|
345
|
+
'$.xgafv'?: '1' | '2';
|
|
346
346
|
/** OAuth access token. */
|
|
347
347
|
access_token?: string;
|
|
348
348
|
/** Data format for response. */
|
|
349
|
-
alt?:
|
|
349
|
+
alt?: 'json' | 'media' | 'proto';
|
|
350
350
|
/** JSONP */
|
|
351
351
|
callback?: string;
|
|
352
352
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -369,11 +369,11 @@ declare namespace gapi.client {
|
|
|
369
369
|
modifyAckDeadline(
|
|
370
370
|
request: {
|
|
371
371
|
/** V1 error format. */
|
|
372
|
-
'$.xgafv'?:
|
|
372
|
+
'$.xgafv'?: '1' | '2';
|
|
373
373
|
/** OAuth access token. */
|
|
374
374
|
access_token?: string;
|
|
375
375
|
/** Data format for response. */
|
|
376
|
-
alt?:
|
|
376
|
+
alt?: 'json' | 'media' | 'proto';
|
|
377
377
|
/** JSONP */
|
|
378
378
|
callback?: string;
|
|
379
379
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -396,11 +396,11 @@ declare namespace gapi.client {
|
|
|
396
396
|
/** Modifies the PushConfig for a specified subscription. This method can be used to suspend the flow of messages to an endpoint by clearing the PushConfig field in the request. Messages will be accumulated for delivery even if no push configuration is defined or while the configuration is modified. */
|
|
397
397
|
modifyPushConfig(request: {
|
|
398
398
|
/** V1 error format. */
|
|
399
|
-
'$.xgafv'?:
|
|
399
|
+
'$.xgafv'?: '1' | '2';
|
|
400
400
|
/** OAuth access token. */
|
|
401
401
|
access_token?: string;
|
|
402
402
|
/** Data format for response. */
|
|
403
|
-
alt?:
|
|
403
|
+
alt?: 'json' | 'media' | 'proto';
|
|
404
404
|
/** JSONP */
|
|
405
405
|
callback?: string;
|
|
406
406
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -423,11 +423,11 @@ declare namespace gapi.client {
|
|
|
423
423
|
modifyPushConfig(
|
|
424
424
|
request: {
|
|
425
425
|
/** V1 error format. */
|
|
426
|
-
'$.xgafv'?:
|
|
426
|
+
'$.xgafv'?: '1' | '2';
|
|
427
427
|
/** OAuth access token. */
|
|
428
428
|
access_token?: string;
|
|
429
429
|
/** Data format for response. */
|
|
430
|
-
alt?:
|
|
430
|
+
alt?: 'json' | 'media' | 'proto';
|
|
431
431
|
/** JSONP */
|
|
432
432
|
callback?: string;
|
|
433
433
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -450,11 +450,11 @@ declare namespace gapi.client {
|
|
|
450
450
|
/** Pulls a single message from the server. If return_immediately is true, and no messages are available in the subscription, this method returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no messages are available in a reasonable amount of time (to reduce system load). */
|
|
451
451
|
pull(request: {
|
|
452
452
|
/** V1 error format. */
|
|
453
|
-
'$.xgafv'?:
|
|
453
|
+
'$.xgafv'?: '1' | '2';
|
|
454
454
|
/** OAuth access token. */
|
|
455
455
|
access_token?: string;
|
|
456
456
|
/** Data format for response. */
|
|
457
|
-
alt?:
|
|
457
|
+
alt?: 'json' | 'media' | 'proto';
|
|
458
458
|
/** JSONP */
|
|
459
459
|
callback?: string;
|
|
460
460
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -477,11 +477,11 @@ declare namespace gapi.client {
|
|
|
477
477
|
pull(
|
|
478
478
|
request: {
|
|
479
479
|
/** V1 error format. */
|
|
480
|
-
'$.xgafv'?:
|
|
480
|
+
'$.xgafv'?: '1' | '2';
|
|
481
481
|
/** OAuth access token. */
|
|
482
482
|
access_token?: string;
|
|
483
483
|
/** Data format for response. */
|
|
484
|
-
alt?:
|
|
484
|
+
alt?: 'json' | 'media' | 'proto';
|
|
485
485
|
/** JSONP */
|
|
486
486
|
callback?: string;
|
|
487
487
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -504,11 +504,11 @@ declare namespace gapi.client {
|
|
|
504
504
|
/** Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The system is free to return UNAVAILABLE if there are too many pull requests outstanding for the given subscription. */
|
|
505
505
|
pullBatch(request: {
|
|
506
506
|
/** V1 error format. */
|
|
507
|
-
'$.xgafv'?:
|
|
507
|
+
'$.xgafv'?: '1' | '2';
|
|
508
508
|
/** OAuth access token. */
|
|
509
509
|
access_token?: string;
|
|
510
510
|
/** Data format for response. */
|
|
511
|
-
alt?:
|
|
511
|
+
alt?: 'json' | 'media' | 'proto';
|
|
512
512
|
/** JSONP */
|
|
513
513
|
callback?: string;
|
|
514
514
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -531,11 +531,11 @@ declare namespace gapi.client {
|
|
|
531
531
|
pullBatch(
|
|
532
532
|
request: {
|
|
533
533
|
/** V1 error format. */
|
|
534
|
-
'$.xgafv'?:
|
|
534
|
+
'$.xgafv'?: '1' | '2';
|
|
535
535
|
/** OAuth access token. */
|
|
536
536
|
access_token?: string;
|
|
537
537
|
/** Data format for response. */
|
|
538
|
-
alt?:
|
|
538
|
+
alt?: 'json' | 'media' | 'proto';
|
|
539
539
|
/** JSONP */
|
|
540
540
|
callback?: string;
|
|
541
541
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -560,11 +560,11 @@ declare namespace gapi.client {
|
|
|
560
560
|
/** Creates the given topic with the given name. */
|
|
561
561
|
create(request: {
|
|
562
562
|
/** V1 error format. */
|
|
563
|
-
'$.xgafv'?:
|
|
563
|
+
'$.xgafv'?: '1' | '2';
|
|
564
564
|
/** OAuth access token. */
|
|
565
565
|
access_token?: string;
|
|
566
566
|
/** Data format for response. */
|
|
567
|
-
alt?:
|
|
567
|
+
alt?: 'json' | 'media' | 'proto';
|
|
568
568
|
/** JSONP */
|
|
569
569
|
callback?: string;
|
|
570
570
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -587,11 +587,11 @@ declare namespace gapi.client {
|
|
|
587
587
|
create(
|
|
588
588
|
request: {
|
|
589
589
|
/** V1 error format. */
|
|
590
|
-
'$.xgafv'?:
|
|
590
|
+
'$.xgafv'?: '1' | '2';
|
|
591
591
|
/** OAuth access token. */
|
|
592
592
|
access_token?: string;
|
|
593
593
|
/** Data format for response. */
|
|
594
|
-
alt?:
|
|
594
|
+
alt?: 'json' | 'media' | 'proto';
|
|
595
595
|
/** JSONP */
|
|
596
596
|
callback?: string;
|
|
597
597
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -614,11 +614,11 @@ declare namespace gapi.client {
|
|
|
614
614
|
/** 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. */
|
|
615
615
|
delete(request?: {
|
|
616
616
|
/** V1 error format. */
|
|
617
|
-
'$.xgafv'?:
|
|
617
|
+
'$.xgafv'?: '1' | '2';
|
|
618
618
|
/** OAuth access token. */
|
|
619
619
|
access_token?: string;
|
|
620
620
|
/** Data format for response. */
|
|
621
|
-
alt?:
|
|
621
|
+
alt?: 'json' | 'media' | 'proto';
|
|
622
622
|
/** JSONP */
|
|
623
623
|
callback?: string;
|
|
624
624
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -641,11 +641,11 @@ declare namespace gapi.client {
|
|
|
641
641
|
/** Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here. */
|
|
642
642
|
get(request?: {
|
|
643
643
|
/** V1 error format. */
|
|
644
|
-
'$.xgafv'?:
|
|
644
|
+
'$.xgafv'?: '1' | '2';
|
|
645
645
|
/** OAuth access token. */
|
|
646
646
|
access_token?: string;
|
|
647
647
|
/** Data format for response. */
|
|
648
|
-
alt?:
|
|
648
|
+
alt?: 'json' | 'media' | 'proto';
|
|
649
649
|
/** JSONP */
|
|
650
650
|
callback?: string;
|
|
651
651
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -668,11 +668,11 @@ declare namespace gapi.client {
|
|
|
668
668
|
/** Lists matching topics. */
|
|
669
669
|
list(request?: {
|
|
670
670
|
/** V1 error format. */
|
|
671
|
-
'$.xgafv'?:
|
|
671
|
+
'$.xgafv'?: '1' | '2';
|
|
672
672
|
/** OAuth access token. */
|
|
673
673
|
access_token?: string;
|
|
674
674
|
/** Data format for response. */
|
|
675
|
-
alt?:
|
|
675
|
+
alt?: 'json' | 'media' | 'proto';
|
|
676
676
|
/** JSONP */
|
|
677
677
|
callback?: string;
|
|
678
678
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -699,11 +699,11 @@ declare namespace gapi.client {
|
|
|
699
699
|
/** Adds a message to the topic. Returns NOT_FOUND if the topic does not exist. */
|
|
700
700
|
publish(request: {
|
|
701
701
|
/** V1 error format. */
|
|
702
|
-
'$.xgafv'?:
|
|
702
|
+
'$.xgafv'?: '1' | '2';
|
|
703
703
|
/** OAuth access token. */
|
|
704
704
|
access_token?: string;
|
|
705
705
|
/** Data format for response. */
|
|
706
|
-
alt?:
|
|
706
|
+
alt?: 'json' | 'media' | 'proto';
|
|
707
707
|
/** JSONP */
|
|
708
708
|
callback?: string;
|
|
709
709
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -726,11 +726,11 @@ declare namespace gapi.client {
|
|
|
726
726
|
publish(
|
|
727
727
|
request: {
|
|
728
728
|
/** V1 error format. */
|
|
729
|
-
'$.xgafv'?:
|
|
729
|
+
'$.xgafv'?: '1' | '2';
|
|
730
730
|
/** OAuth access token. */
|
|
731
731
|
access_token?: string;
|
|
732
732
|
/** Data format for response. */
|
|
733
|
-
alt?:
|
|
733
|
+
alt?: 'json' | 'media' | 'proto';
|
|
734
734
|
/** JSONP */
|
|
735
735
|
callback?: string;
|
|
736
736
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -753,11 +753,11 @@ declare namespace gapi.client {
|
|
|
753
753
|
/** Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. */
|
|
754
754
|
publishBatch(request: {
|
|
755
755
|
/** V1 error format. */
|
|
756
|
-
'$.xgafv'?:
|
|
756
|
+
'$.xgafv'?: '1' | '2';
|
|
757
757
|
/** OAuth access token. */
|
|
758
758
|
access_token?: string;
|
|
759
759
|
/** Data format for response. */
|
|
760
|
-
alt?:
|
|
760
|
+
alt?: 'json' | 'media' | 'proto';
|
|
761
761
|
/** JSONP */
|
|
762
762
|
callback?: string;
|
|
763
763
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -780,11 +780,11 @@ declare namespace gapi.client {
|
|
|
780
780
|
publishBatch(
|
|
781
781
|
request: {
|
|
782
782
|
/** V1 error format. */
|
|
783
|
-
'$.xgafv'?:
|
|
783
|
+
'$.xgafv'?: '1' | '2';
|
|
784
784
|
/** OAuth access token. */
|
|
785
785
|
access_token?: string;
|
|
786
786
|
/** Data format for response. */
|
|
787
|
-
alt?:
|
|
787
|
+
alt?: 'json' | 'media' | 'proto';
|
|
788
788
|
/** JSONP */
|
|
789
789
|
callback?: string;
|
|
790
790
|
/** Selector specifying which fields to include in a partial response. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,23 @@ Install typings for Cloud Pub/Sub API:
|
|
|
11
11
|
npm install @types/gapi.client.pubsub-v1beta1a --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": [
|
|
22
|
+
"gapi",
|
|
23
|
+
"gapi.auth2",
|
|
24
|
+
"gapi.client",
|
|
25
|
+
"gapi.client.pubsub-v1beta1a"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
14
31
|
## Usage
|
|
15
32
|
|
|
16
33
|
You need to initialize Google API client in your code:
|