@maxim_mazurok/gapi.client.firestore-v1 0.1.20260310 → 0.2.20260529

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 +371 -216
  2. package/package.json +1 -1
  3. 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://firestore.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20260310
12
+ // Revision: 20260529
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -122,7 +122,7 @@ declare namespace gapi.client {
122
122
  /** The list of filters to combine. Requires: * At least one filter is present. */
123
123
  filters?: Filter[];
124
124
  /** The operator for combining multiple filters. */
125
- op?: string;
125
+ op?: 'OPERATOR_UNSPECIFIED' | 'AND' | 'OR';
126
126
  }
127
127
  interface Count {
128
128
  /** Optional. Optional constraint on the maximum number of documents to count. This provides a way to set an upper bound on the number of documents to scan, limiting latency, and cost. Unspecified is interpreted as no bound. High-Level Example: ``` AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); ``` Requires: * Must be greater than zero when present. */
@@ -239,7 +239,18 @@ declare namespace gapi.client {
239
239
  /** The field to filter by. */
240
240
  field?: FieldReference;
241
241
  /** The operator to filter by. */
242
- op?: string;
242
+ op?:
243
+ | 'OPERATOR_UNSPECIFIED'
244
+ | 'LESS_THAN'
245
+ | 'LESS_THAN_OR_EQUAL'
246
+ | 'GREATER_THAN'
247
+ | 'GREATER_THAN_OR_EQUAL'
248
+ | 'EQUAL'
249
+ | 'NOT_EQUAL'
250
+ | 'ARRAY_CONTAINS'
251
+ | 'IN'
252
+ | 'ARRAY_CONTAINS_ANY'
253
+ | 'NOT_IN';
243
254
  /** The value to compare to. */
244
255
  value?: Value;
245
256
  }
@@ -261,7 +272,7 @@ declare namespace gapi.client {
261
272
  /** Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. */
262
273
  removeAllFromArray?: ArrayValue;
263
274
  /** Sets the field to the given server value. */
264
- setToServerValue?: string;
275
+ setToServerValue?: 'SERVER_VALUE_UNSPECIFIED' | 'REQUEST_TIME';
265
276
  }
266
277
  interface Filter {
267
278
  /** A composite filter. */
@@ -273,7 +284,11 @@ declare namespace gapi.client {
273
284
  }
274
285
  interface FindNearest {
275
286
  /** Required. The distance measure to use, required. */
276
- distanceMeasure?: string;
287
+ distanceMeasure?:
288
+ | 'DISTANCE_MEASURE_UNSPECIFIED'
289
+ | 'EUCLIDEAN'
290
+ | 'COSINE'
291
+ | 'DOT_PRODUCT';
277
292
  /** Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations. */
278
293
  distanceResultField?: string;
279
294
  /** Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: `WHERE distance <= distance_threshold` * For DOT_PRODUCT: `WHERE distance >= distance_threshold` */
@@ -305,7 +320,7 @@ declare namespace gapi.client {
305
320
  /** Output only. The backup contains an externally consistent copy of the database at this time. */
306
321
  snapshotTime?: string;
307
322
  /** Output only. The current state of the backup. */
308
- state?: string;
323
+ state?: 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'NOT_AVAILABLE';
309
324
  /** Output only. Statistics about the backup. This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then. */
310
325
  stats?: GoogleFirestoreAdminV1Stats;
311
326
  }
@@ -335,7 +350,15 @@ declare namespace gapi.client {
335
350
  /** Which namespace IDs are being deleted. */
336
351
  namespaceIds?: string[];
337
352
  /** The state of the operation. */
338
- operationState?: string;
353
+ operationState?:
354
+ | 'OPERATION_STATE_UNSPECIFIED'
355
+ | 'INITIALIZING'
356
+ | 'PROCESSING'
357
+ | 'CANCELLING'
358
+ | 'FINALIZING'
359
+ | 'SUCCESSFUL'
360
+ | 'FAILED'
361
+ | 'CANCELLED';
339
362
  /** The progress, in bytes, of this operation. */
340
363
  progressBytes?: GoogleFirestoreAdminV1Progress;
341
364
  /** The progress, in documents, of this operation. */
@@ -357,7 +380,15 @@ declare namespace gapi.client {
357
380
  /** The time the clone finished, unset for ongoing clones. */
358
381
  endTime?: string;
359
382
  /** The operation state of the clone. */
360
- operationState?: string;
383
+ operationState?:
384
+ | 'OPERATION_STATE_UNSPECIFIED'
385
+ | 'INITIALIZING'
386
+ | 'PROCESSING'
387
+ | 'CANCELLING'
388
+ | 'FINALIZING'
389
+ | 'SUCCESSFUL'
390
+ | 'FAILED'
391
+ | 'CANCELLED';
361
392
  /** The snapshot from which this database was cloned. */
362
393
  pitrSnapshot?: GoogleFirestoreAdminV1PitrSnapshot;
363
394
  /** How far along the clone is as an estimated percentage of remaining time. */
@@ -389,17 +420,30 @@ declare namespace gapi.client {
389
420
  interface GoogleFirestoreAdminV1DailyRecurrence {}
390
421
  interface GoogleFirestoreAdminV1Database {
391
422
  /** The App Engine integration mode to use for this database. */
392
- appEngineIntegrationMode?: string;
423
+ appEngineIntegrationMode?:
424
+ | 'APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED'
425
+ | 'ENABLED'
426
+ | 'DISABLED';
393
427
  /** Optional. Presence indicates CMEK is enabled for this database. */
394
428
  cmekConfig?: GoogleFirestoreAdminV1CmekConfig;
395
- /** The concurrency control mode to use for this database. If unspecified in a CreateDatabase request, this will default based on the database edition: Optimistic for Enterprise and Pessimistic for all other databases. */
396
- concurrencyMode?: string;
429
+ /** The default concurrency control mode to use for this database. If unspecified in a CreateDatabase request, this will default based on the database edition: Optimistic for Enterprise and Pessimistic for all other databases. While transactions can explicitly specify their own concurrency mode, this setting defines the default behavior when left unspecified. Important: This database-level setting is not respected for Firestore with MongoDB compatibility. All transactions through the MongoDB compatibility layer will use optimistic concurrency control, regardless of this setting. */
430
+ concurrencyMode?:
431
+ | 'CONCURRENCY_MODE_UNSPECIFIED'
432
+ | 'OPTIMISTIC'
433
+ | 'PESSIMISTIC'
434
+ | 'OPTIMISTIC_WITH_ENTITY_GROUPS';
397
435
  /** Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time. */
398
436
  createTime?: string;
399
437
  /** Immutable. The edition of the database. */
400
- databaseEdition?: string;
438
+ databaseEdition?:
439
+ | 'DATABASE_EDITION_UNSPECIFIED'
440
+ | 'STANDARD'
441
+ | 'ENTERPRISE';
401
442
  /** State of delete protection for the database. */
402
- deleteProtectionState?: string;
443
+ deleteProtectionState?:
444
+ | 'DELETE_PROTECTION_STATE_UNSPECIFIED'
445
+ | 'DELETE_PROTECTION_DISABLED'
446
+ | 'DELETE_PROTECTION_ENABLED';
403
447
  /** Output only. The timestamp at which this database was deleted. Only set if the database has been deleted. */
404
448
  deleteTime?: string;
405
449
  /** Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. */
@@ -407,7 +451,10 @@ declare namespace gapi.client {
407
451
  /** This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */
408
452
  etag?: string;
409
453
  /** Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. */
410
- firestoreDataAccessMode?: string;
454
+ firestoreDataAccessMode?:
455
+ | 'DATA_ACCESS_MODE_UNSPECIFIED'
456
+ | 'DATA_ACCESS_MODE_ENABLED'
457
+ | 'DATA_ACCESS_MODE_DISABLED';
411
458
  /** Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. */
412
459
  freeTier?: boolean;
413
460
  /** Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). */
@@ -415,21 +462,33 @@ declare namespace gapi.client {
415
462
  /** Required. The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. */
416
463
  locationId?: string;
417
464
  /** Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. */
418
- mongodbCompatibleDataAccessMode?: string;
465
+ mongodbCompatibleDataAccessMode?:
466
+ | 'DATA_ACCESS_MODE_UNSPECIFIED'
467
+ | 'DATA_ACCESS_MODE_ENABLED'
468
+ | 'DATA_ACCESS_MODE_DISABLED';
419
469
  /** The resource name of the Database. Format: `projects/{project}/databases/{database}` */
420
470
  name?: string;
421
471
  /** Whether to enable the PITR feature on this database. */
422
- pointInTimeRecoveryEnablement?: string;
472
+ pointInTimeRecoveryEnablement?:
473
+ | 'POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED'
474
+ | 'POINT_IN_TIME_RECOVERY_ENABLED'
475
+ | 'POINT_IN_TIME_RECOVERY_DISABLED';
423
476
  /** Output only. The database resource's prior database ID. This field is only populated for deleted databases. */
424
477
  previousId?: string;
425
478
  /** Immutable. The default Realtime Updates mode to use for this database. */
426
- realtimeUpdatesMode?: string;
479
+ realtimeUpdatesMode?:
480
+ | 'REALTIME_UPDATES_MODE_UNSPECIFIED'
481
+ | 'REALTIME_UPDATES_MODE_ENABLED'
482
+ | 'REALTIME_UPDATES_MODE_DISABLED';
427
483
  /** Output only. Information about the provenance of this database. */
428
484
  sourceInfo?: GoogleFirestoreAdminV1SourceInfo;
429
485
  /** Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" */
430
486
  tags?: {[P in string]: string};
431
487
  /** Required. The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. */
432
- type?: string;
488
+ type?:
489
+ | 'DATABASE_TYPE_UNSPECIFIED'
490
+ | 'FIRESTORE_NATIVE'
491
+ | 'DATASTORE_MODE';
433
492
  /** Output only. The system-generated UUID4 for this Database. */
434
493
  uid?: string;
435
494
  /** Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database. */
@@ -456,7 +515,15 @@ declare namespace gapi.client {
456
515
  /** Which namespace IDs are being exported. */
457
516
  namespaceIds?: string[];
458
517
  /** The state of the export operation. */
459
- operationState?: string;
518
+ operationState?:
519
+ | 'OPERATION_STATE_UNSPECIFIED'
520
+ | 'INITIALIZING'
521
+ | 'PROCESSING'
522
+ | 'CANCELLING'
523
+ | 'FINALIZING'
524
+ | 'SUCCESSFUL'
525
+ | 'FAILED'
526
+ | 'CANCELLED';
460
527
  /** Where the documents are being exported to. */
461
528
  outputUriPrefix?: string;
462
529
  /** The progress, in bytes, of this operation. */
@@ -504,7 +571,15 @@ declare namespace gapi.client {
504
571
  /** The time this operation started. */
505
572
  startTime?: string;
506
573
  /** The state of the operation. */
507
- state?: string;
574
+ state?:
575
+ | 'OPERATION_STATE_UNSPECIFIED'
576
+ | 'INITIALIZING'
577
+ | 'PROCESSING'
578
+ | 'CANCELLING'
579
+ | 'FINALIZING'
580
+ | 'SUCCESSFUL'
581
+ | 'FAILED'
582
+ | 'CANCELLED';
508
583
  /** Describes the deltas of TTL configuration. */
509
584
  ttlConfigDelta?: GoogleFirestoreAdminV1TtlConfigDelta;
510
585
  }
@@ -520,7 +595,15 @@ declare namespace gapi.client {
520
595
  /** Which namespace IDs are being imported. */
521
596
  namespaceIds?: string[];
522
597
  /** The state of the import operation. */
523
- operationState?: string;
598
+ operationState?:
599
+ | 'OPERATION_STATE_UNSPECIFIED'
600
+ | 'INITIALIZING'
601
+ | 'PROCESSING'
602
+ | 'CANCELLING'
603
+ | 'FINALIZING'
604
+ | 'SUCCESSFUL'
605
+ | 'FAILED'
606
+ | 'CANCELLED';
524
607
  /** The progress, in bytes, of this operation. */
525
608
  progressBytes?: GoogleFirestoreAdminV1Progress;
526
609
  /** The progress, in documents, of this operation. */
@@ -538,9 +621,9 @@ declare namespace gapi.client {
538
621
  }
539
622
  interface GoogleFirestoreAdminV1Index {
540
623
  /** The API scope supported by this index. */
541
- apiScope?: string;
624
+ apiScope?: 'ANY_API' | 'DATASTORE_MODE_API' | 'MONGODB_COMPATIBLE_API';
542
625
  /** Immutable. The density configuration of the index. */
543
- density?: string;
626
+ density?: 'DENSITY_UNSPECIFIED' | 'SPARSE_ALL' | 'SPARSE_ANY' | 'DENSE';
544
627
  /** The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. */
545
628
  fields?: GoogleFirestoreAdminV1IndexField[];
546
629
  /** Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope. */
@@ -548,11 +631,17 @@ declare namespace gapi.client {
548
631
  /** Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. */
549
632
  name?: string;
550
633
  /** Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index. */
551
- queryScope?: string;
634
+ queryScope?:
635
+ | 'QUERY_SCOPE_UNSPECIFIED'
636
+ | 'COLLECTION'
637
+ | 'COLLECTION_GROUP'
638
+ | 'COLLECTION_RECURSIVE';
639
+ /** Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. */
640
+ searchIndexOptions?: GoogleFirestoreAdminV1SearchIndexOptions;
552
641
  /** Optional. The number of shards for the index. */
553
642
  shardCount?: number;
554
643
  /** Output only. The serving state of the index. */
555
- state?: string;
644
+ state?: 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'NEEDS_REPAIR';
556
645
  /** Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. */
557
646
  unique?: boolean;
558
647
  }
@@ -568,17 +657,19 @@ declare namespace gapi.client {
568
657
  }
569
658
  interface GoogleFirestoreAdminV1IndexConfigDelta {
570
659
  /** Specifies how the index is changing. */
571
- changeType?: string;
660
+ changeType?: 'CHANGE_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE';
572
661
  /** The index being changed. */
573
662
  index?: GoogleFirestoreAdminV1Index;
574
663
  }
575
664
  interface GoogleFirestoreAdminV1IndexField {
576
665
  /** Indicates that this field supports operations on `array_value`s. */
577
- arrayConfig?: string;
666
+ arrayConfig?: 'ARRAY_CONFIG_UNSPECIFIED' | 'CONTAINS';
578
667
  /** Can be __name__. For single field indexes, this must match the name of the field or may be omitted. */
579
668
  fieldPath?: string;
580
669
  /** Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. */
581
- order?: string;
670
+ order?: 'ORDER_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
671
+ /** Indicates that this field supports search operations. */
672
+ searchConfig?: GoogleFirestoreAdminV1SearchConfig;
582
673
  /** Indicates that this field supports nearest neighbor and distance operations on vector. */
583
674
  vectorConfig?: GoogleFirestoreAdminV1VectorConfig;
584
675
  }
@@ -594,7 +685,15 @@ declare namespace gapi.client {
594
685
  /** The time this operation started. */
595
686
  startTime?: string;
596
687
  /** The state of the operation. */
597
- state?: string;
688
+ state?:
689
+ | 'OPERATION_STATE_UNSPECIFIED'
690
+ | 'INITIALIZING'
691
+ | 'PROCESSING'
692
+ | 'CANCELLING'
693
+ | 'FINALIZING'
694
+ | 'SUCCESSFUL'
695
+ | 'FAILED'
696
+ | 'CANCELLED';
598
697
  }
599
698
  interface GoogleFirestoreAdminV1ListBackupSchedulesResponse {
600
699
  /** List of all backup schedules. */
@@ -656,7 +755,15 @@ declare namespace gapi.client {
656
755
  /** The time the restore finished, unset for ongoing restores. */
657
756
  endTime?: string;
658
757
  /** The operation state of the restore. */
659
- operationState?: string;
758
+ operationState?:
759
+ | 'OPERATION_STATE_UNSPECIFIED'
760
+ | 'INITIALIZING'
761
+ | 'PROCESSING'
762
+ | 'CANCELLING'
763
+ | 'FINALIZING'
764
+ | 'SUCCESSFUL'
765
+ | 'FAILED'
766
+ | 'CANCELLED';
660
767
  /** How far along the restore is as an estimated percentage of remaining time. */
661
768
  progressPercentage?: GoogleFirestoreAdminV1Progress;
662
769
  /** The time the restore was started. */
@@ -672,6 +779,32 @@ declare namespace gapi.client {
672
779
  /** Optional. Immutable. Tags to be bound to the restored database. The tags should be provided in the format of `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`. */
673
780
  tags?: {[P in string]: string};
674
781
  }
782
+ interface GoogleFirestoreAdminV1SearchConfig {
783
+ /** Optional. The specification for building a geo search index for a field. */
784
+ geoSpec?: GoogleFirestoreAdminV1SearchGeoSpec;
785
+ /** Optional. The specification for building a text search index for a field. */
786
+ textSpec?: GoogleFirestoreAdminV1SearchTextSpec;
787
+ }
788
+ interface GoogleFirestoreAdminV1SearchGeoSpec {
789
+ /** Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. */
790
+ geoJsonIndexingDisabled?: boolean;
791
+ }
792
+ interface GoogleFirestoreAdminV1SearchIndexOptions {
793
+ /** Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. */
794
+ textLanguage?: string;
795
+ /** Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. */
796
+ textLanguageOverrideFieldPath?: string;
797
+ }
798
+ interface GoogleFirestoreAdminV1SearchTextIndexSpec {
799
+ /** Required. How to index the text field value. */
800
+ indexType?: 'TEXT_INDEX_TYPE_UNSPECIFIED' | 'TOKENIZED';
801
+ /** Required. How to match the text field value. */
802
+ matchType?: 'TEXT_MATCH_TYPE_UNSPECIFIED' | 'MATCH_GLOBALLY';
803
+ }
804
+ interface GoogleFirestoreAdminV1SearchTextSpec {
805
+ /** Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. */
806
+ indexSpecs?: GoogleFirestoreAdminV1SearchTextIndexSpec[];
807
+ }
675
808
  interface GoogleFirestoreAdminV1SourceEncryptionOptions {}
676
809
  interface GoogleFirestoreAdminV1SourceInfo {
677
810
  /** If set, this database was restored from the specified backup (or a snapshot thereof). */
@@ -688,12 +821,16 @@ declare namespace gapi.client {
688
821
  sizeBytes?: string;
689
822
  }
690
823
  interface GoogleFirestoreAdminV1TtlConfig {
824
+ /** Optional. The offset, relative to the timestamp value from the TTL-enabled field, used to determine the document's expiration time. `expiration_offset.seconds` must be between 0 and 2,147,483,647 inclusive. Values more precise than seconds are rejected. If unset, defaults to 0, in which case the expiration time is the same as the timestamp value from the TTL-enabled field. */
825
+ expirationOffset?: string;
691
826
  /** Output only. The state of the TTL configuration. */
692
- state?: string;
827
+ state?: 'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'NEEDS_REPAIR';
693
828
  }
694
829
  interface GoogleFirestoreAdminV1TtlConfigDelta {
695
830
  /** Specifies how the TTL configuration is changing. */
696
- changeType?: string;
831
+ changeType?: 'CHANGE_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE';
832
+ /** The offset, relative to the timestamp value in the TTL-enabled field, used determine the document's expiration time. */
833
+ expirationOffset?: string;
697
834
  }
698
835
  interface GoogleFirestoreAdminV1UpdateDatabaseMetadata {}
699
836
  interface GoogleFirestoreAdminV1UserCreds {
@@ -706,7 +843,7 @@ declare namespace gapi.client {
706
843
  /** Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword. */
707
844
  securePassword?: string;
708
845
  /** Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation. */
709
- state?: string;
846
+ state?: 'STATE_UNSPECIFIED' | 'ENABLED' | 'DISABLED';
710
847
  /** Output only. The time the user creds were last updated. */
711
848
  updateTime?: string;
712
849
  }
@@ -718,7 +855,15 @@ declare namespace gapi.client {
718
855
  }
719
856
  interface GoogleFirestoreAdminV1WeeklyRecurrence {
720
857
  /** The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. */
721
- day?: string;
858
+ day?:
859
+ | 'DAY_OF_WEEK_UNSPECIFIED'
860
+ | 'MONDAY'
861
+ | 'TUESDAY'
862
+ | 'WEDNESDAY'
863
+ | 'THURSDAY'
864
+ | 'FRIDAY'
865
+ | 'SATURDAY'
866
+ | 'SUNDAY';
722
867
  }
723
868
  interface GoogleLongrunningCancelOperationRequest {}
724
869
  interface GoogleLongrunningListOperationsResponse {
@@ -811,7 +956,7 @@ declare namespace gapi.client {
811
956
  }
812
957
  interface Order {
813
958
  /** The direction to order by. Defaults to `ASCENDING`. */
814
- direction?: string;
959
+ direction?: 'DIRECTION_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
815
960
  /** The field to order by. */
816
961
  field?: FieldReference;
817
962
  }
@@ -839,7 +984,7 @@ declare namespace gapi.client {
839
984
  }
840
985
  interface PlanSummary {
841
986
  /** The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"} ] */
842
- indexesUsed?: Array<{[P in string]: any}>;
987
+ indexesUsed?: {[P in string]: any}[];
843
988
  }
844
989
  interface Precondition {
845
990
  /** When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */
@@ -862,6 +1007,11 @@ declare namespace gapi.client {
862
1007
  readTime?: string;
863
1008
  }
864
1009
  interface ReadWrite {
1010
+ /** Optional. The concurrency control mode to use for this transaction. A database is able to use different concurrency modes for different transactions simultaneously. 3rd party auth requests are only allowed to create optimistic read-write transactions and must specify that here even if the database-level setting is already configured to optimistic. */
1011
+ concurrencyMode?:
1012
+ | 'CONCURRENCY_MODE_UNSPECIFIED'
1013
+ | 'OPTIMISTIC'
1014
+ | 'PESSIMISTIC';
865
1015
  /** An optional transaction to retry. */
866
1016
  retryTransaction?: string;
867
1017
  }
@@ -929,7 +1079,7 @@ declare namespace gapi.client {
929
1079
  /** The status code, which should be an enum value of google.rpc.Code. */
930
1080
  code?: number;
931
1081
  /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
932
- details?: Array<{[P in string]: any}>;
1082
+ details?: {[P in string]: any}[];
933
1083
  /** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
934
1084
  message?: string;
935
1085
  }
@@ -993,7 +1143,7 @@ declare namespace gapi.client {
993
1143
  /** A token that can be used to resume the stream for the given `target_ids`, or all targets if `target_ids` is empty. Not set on every target change. */
994
1144
  resumeToken?: string;
995
1145
  /** The type of change that occurred. */
996
- targetChangeType?: string;
1146
+ targetChangeType?: 'NO_CHANGE' | 'ADD' | 'REMOVE' | 'CURRENT' | 'RESET';
997
1147
  /** The target IDs of targets that have changed. If empty, the change applies to all targets. The order of the target IDs is not defined. */
998
1148
  targetIds?: number[];
999
1149
  }
@@ -1007,7 +1157,12 @@ declare namespace gapi.client {
1007
1157
  /** The field to which to apply the operator. */
1008
1158
  field?: FieldReference;
1009
1159
  /** The unary operator to apply. */
1010
- op?: string;
1160
+ op?:
1161
+ | 'OPERATOR_UNSPECIFIED'
1162
+ | 'IS_NAN'
1163
+ | 'IS_NULL'
1164
+ | 'IS_NOT_NAN'
1165
+ | 'IS_NOT_NULL';
1011
1166
  }
1012
1167
  interface Value {
1013
1168
  /** An array value. Cannot directly contain another array value, though can contain a map which contains another array. */
@@ -1029,7 +1184,7 @@ declare namespace gapi.client {
1029
1184
  /** A map value. */
1030
1185
  mapValue?: MapValue;
1031
1186
  /** A null value. */
1032
- nullValue?: string;
1187
+ nullValue?: 'NULL_VALUE';
1033
1188
  /** A value that represents an unevaluated pipeline. **Requires:** * Not allowed to be used when writing documents. */
1034
1189
  pipelineValue?: Pipeline;
1035
1190
  /** A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */
@@ -1085,11 +1240,11 @@ declare namespace gapi.client {
1085
1240
  /** Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule. */
1086
1241
  create(request: {
1087
1242
  /** V1 error format. */
1088
- '$.xgafv'?: string;
1243
+ '$.xgafv'?: '1' | '2';
1089
1244
  /** OAuth access token. */
1090
1245
  access_token?: string;
1091
1246
  /** Data format for response. */
1092
- alt?: string;
1247
+ alt?: 'json' | 'media' | 'proto';
1093
1248
  /** JSONP */
1094
1249
  callback?: string;
1095
1250
  /** Selector specifying which fields to include in a partial response. */
@@ -1114,11 +1269,11 @@ declare namespace gapi.client {
1114
1269
  create(
1115
1270
  request: {
1116
1271
  /** V1 error format. */
1117
- '$.xgafv'?: string;
1272
+ '$.xgafv'?: '1' | '2';
1118
1273
  /** OAuth access token. */
1119
1274
  access_token?: string;
1120
1275
  /** Data format for response. */
1121
- alt?: string;
1276
+ alt?: 'json' | 'media' | 'proto';
1122
1277
  /** JSONP */
1123
1278
  callback?: string;
1124
1279
  /** Selector specifying which fields to include in a partial response. */
@@ -1143,11 +1298,11 @@ declare namespace gapi.client {
1143
1298
  /** Deletes a backup schedule. */
1144
1299
  delete(request?: {
1145
1300
  /** V1 error format. */
1146
- '$.xgafv'?: string;
1301
+ '$.xgafv'?: '1' | '2';
1147
1302
  /** OAuth access token. */
1148
1303
  access_token?: string;
1149
1304
  /** Data format for response. */
1150
- alt?: string;
1305
+ alt?: 'json' | 'media' | 'proto';
1151
1306
  /** JSONP */
1152
1307
  callback?: string;
1153
1308
  /** Selector specifying which fields to include in a partial response. */
@@ -1170,11 +1325,11 @@ declare namespace gapi.client {
1170
1325
  /** Gets information about a backup schedule. */
1171
1326
  get(request?: {
1172
1327
  /** V1 error format. */
1173
- '$.xgafv'?: string;
1328
+ '$.xgafv'?: '1' | '2';
1174
1329
  /** OAuth access token. */
1175
1330
  access_token?: string;
1176
1331
  /** Data format for response. */
1177
- alt?: string;
1332
+ alt?: 'json' | 'media' | 'proto';
1178
1333
  /** JSONP */
1179
1334
  callback?: string;
1180
1335
  /** Selector specifying which fields to include in a partial response. */
@@ -1197,11 +1352,11 @@ declare namespace gapi.client {
1197
1352
  /** List backup schedules. */
1198
1353
  list(request?: {
1199
1354
  /** V1 error format. */
1200
- '$.xgafv'?: string;
1355
+ '$.xgafv'?: '1' | '2';
1201
1356
  /** OAuth access token. */
1202
1357
  access_token?: string;
1203
1358
  /** Data format for response. */
1204
- alt?: string;
1359
+ alt?: 'json' | 'media' | 'proto';
1205
1360
  /** JSONP */
1206
1361
  callback?: string;
1207
1362
  /** Selector specifying which fields to include in a partial response. */
@@ -1224,11 +1379,11 @@ declare namespace gapi.client {
1224
1379
  /** Updates a backup schedule. */
1225
1380
  patch(request: {
1226
1381
  /** V1 error format. */
1227
- '$.xgafv'?: string;
1382
+ '$.xgafv'?: '1' | '2';
1228
1383
  /** OAuth access token. */
1229
1384
  access_token?: string;
1230
1385
  /** Data format for response. */
1231
- alt?: string;
1386
+ alt?: 'json' | 'media' | 'proto';
1232
1387
  /** JSONP */
1233
1388
  callback?: string;
1234
1389
  /** Selector specifying which fields to include in a partial response. */
@@ -1255,11 +1410,11 @@ declare namespace gapi.client {
1255
1410
  patch(
1256
1411
  request: {
1257
1412
  /** V1 error format. */
1258
- '$.xgafv'?: string;
1413
+ '$.xgafv'?: '1' | '2';
1259
1414
  /** OAuth access token. */
1260
1415
  access_token?: string;
1261
1416
  /** Data format for response. */
1262
- alt?: string;
1417
+ alt?: 'json' | 'media' | 'proto';
1263
1418
  /** JSONP */
1264
1419
  callback?: string;
1265
1420
  /** Selector specifying which fields to include in a partial response. */
@@ -1288,11 +1443,11 @@ declare namespace gapi.client {
1288
1443
  /** Gets the metadata and configuration for a Field. */
1289
1444
  get(request?: {
1290
1445
  /** V1 error format. */
1291
- '$.xgafv'?: string;
1446
+ '$.xgafv'?: '1' | '2';
1292
1447
  /** OAuth access token. */
1293
1448
  access_token?: string;
1294
1449
  /** Data format for response. */
1295
- alt?: string;
1450
+ alt?: 'json' | 'media' | 'proto';
1296
1451
  /** JSONP */
1297
1452
  callback?: string;
1298
1453
  /** Selector specifying which fields to include in a partial response. */
@@ -1315,11 +1470,11 @@ declare namespace gapi.client {
1315
1470
  /** Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false` or `ttlConfig:*`. */
1316
1471
  list(request?: {
1317
1472
  /** V1 error format. */
1318
- '$.xgafv'?: string;
1473
+ '$.xgafv'?: '1' | '2';
1319
1474
  /** OAuth access token. */
1320
1475
  access_token?: string;
1321
1476
  /** Data format for response. */
1322
- alt?: string;
1477
+ alt?: 'json' | 'media' | 'proto';
1323
1478
  /** JSONP */
1324
1479
  callback?: string;
1325
1480
  /** Selector specifying which fields to include in a partial response. */
@@ -1348,11 +1503,11 @@ declare namespace gapi.client {
1348
1503
  /** Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`. */
1349
1504
  patch(request: {
1350
1505
  /** V1 error format. */
1351
- '$.xgafv'?: string;
1506
+ '$.xgafv'?: '1' | '2';
1352
1507
  /** OAuth access token. */
1353
1508
  access_token?: string;
1354
1509
  /** Data format for response. */
1355
- alt?: string;
1510
+ alt?: 'json' | 'media' | 'proto';
1356
1511
  /** JSONP */
1357
1512
  callback?: string;
1358
1513
  /** Selector specifying which fields to include in a partial response. */
@@ -1379,11 +1534,11 @@ declare namespace gapi.client {
1379
1534
  patch(
1380
1535
  request: {
1381
1536
  /** V1 error format. */
1382
- '$.xgafv'?: string;
1537
+ '$.xgafv'?: '1' | '2';
1383
1538
  /** OAuth access token. */
1384
1539
  access_token?: string;
1385
1540
  /** Data format for response. */
1386
- alt?: string;
1541
+ alt?: 'json' | 'media' | 'proto';
1387
1542
  /** JSONP */
1388
1543
  callback?: string;
1389
1544
  /** Selector specifying which fields to include in a partial response. */
@@ -1412,11 +1567,11 @@ declare namespace gapi.client {
1412
1567
  /** Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. */
1413
1568
  create(request: {
1414
1569
  /** V1 error format. */
1415
- '$.xgafv'?: string;
1570
+ '$.xgafv'?: '1' | '2';
1416
1571
  /** OAuth access token. */
1417
1572
  access_token?: string;
1418
1573
  /** Data format for response. */
1419
- alt?: string;
1574
+ alt?: 'json' | 'media' | 'proto';
1420
1575
  /** JSONP */
1421
1576
  callback?: string;
1422
1577
  /** Selector specifying which fields to include in a partial response. */
@@ -1441,11 +1596,11 @@ declare namespace gapi.client {
1441
1596
  create(
1442
1597
  request: {
1443
1598
  /** V1 error format. */
1444
- '$.xgafv'?: string;
1599
+ '$.xgafv'?: '1' | '2';
1445
1600
  /** OAuth access token. */
1446
1601
  access_token?: string;
1447
1602
  /** Data format for response. */
1448
- alt?: string;
1603
+ alt?: 'json' | 'media' | 'proto';
1449
1604
  /** JSONP */
1450
1605
  callback?: string;
1451
1606
  /** Selector specifying which fields to include in a partial response. */
@@ -1470,11 +1625,11 @@ declare namespace gapi.client {
1470
1625
  /** Deletes a composite index. */
1471
1626
  delete(request?: {
1472
1627
  /** V1 error format. */
1473
- '$.xgafv'?: string;
1628
+ '$.xgafv'?: '1' | '2';
1474
1629
  /** OAuth access token. */
1475
1630
  access_token?: string;
1476
1631
  /** Data format for response. */
1477
- alt?: string;
1632
+ alt?: 'json' | 'media' | 'proto';
1478
1633
  /** JSONP */
1479
1634
  callback?: string;
1480
1635
  /** Selector specifying which fields to include in a partial response. */
@@ -1497,11 +1652,11 @@ declare namespace gapi.client {
1497
1652
  /** Gets a composite index. */
1498
1653
  get(request?: {
1499
1654
  /** V1 error format. */
1500
- '$.xgafv'?: string;
1655
+ '$.xgafv'?: '1' | '2';
1501
1656
  /** OAuth access token. */
1502
1657
  access_token?: string;
1503
1658
  /** Data format for response. */
1504
- alt?: string;
1659
+ alt?: 'json' | 'media' | 'proto';
1505
1660
  /** JSONP */
1506
1661
  callback?: string;
1507
1662
  /** Selector specifying which fields to include in a partial response. */
@@ -1524,11 +1679,11 @@ declare namespace gapi.client {
1524
1679
  /** Lists composite indexes. */
1525
1680
  list(request?: {
1526
1681
  /** V1 error format. */
1527
- '$.xgafv'?: string;
1682
+ '$.xgafv'?: '1' | '2';
1528
1683
  /** OAuth access token. */
1529
1684
  access_token?: string;
1530
1685
  /** Data format for response. */
1531
- alt?: string;
1686
+ alt?: 'json' | 'media' | 'proto';
1532
1687
  /** JSONP */
1533
1688
  callback?: string;
1534
1689
  /** Selector specifying which fields to include in a partial response. */
@@ -1563,11 +1718,11 @@ declare namespace gapi.client {
1563
1718
  /** Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested. */
1564
1719
  batchGet(request: {
1565
1720
  /** V1 error format. */
1566
- '$.xgafv'?: string;
1721
+ '$.xgafv'?: '1' | '2';
1567
1722
  /** OAuth access token. */
1568
1723
  access_token?: string;
1569
1724
  /** Data format for response. */
1570
- alt?: string;
1725
+ alt?: 'json' | 'media' | 'proto';
1571
1726
  /** JSONP */
1572
1727
  callback?: string;
1573
1728
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1592,11 +1747,11 @@ declare namespace gapi.client {
1592
1747
  batchGet(
1593
1748
  request: {
1594
1749
  /** V1 error format. */
1595
- '$.xgafv'?: string;
1750
+ '$.xgafv'?: '1' | '2';
1596
1751
  /** OAuth access token. */
1597
1752
  access_token?: string;
1598
1753
  /** Data format for response. */
1599
- alt?: string;
1754
+ alt?: 'json' | 'media' | 'proto';
1600
1755
  /** JSONP */
1601
1756
  callback?: string;
1602
1757
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1621,11 +1776,11 @@ declare namespace gapi.client {
1621
1776
  /** Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead. */
1622
1777
  batchWrite(request: {
1623
1778
  /** V1 error format. */
1624
- '$.xgafv'?: string;
1779
+ '$.xgafv'?: '1' | '2';
1625
1780
  /** OAuth access token. */
1626
1781
  access_token?: string;
1627
1782
  /** Data format for response. */
1628
- alt?: string;
1783
+ alt?: 'json' | 'media' | 'proto';
1629
1784
  /** JSONP */
1630
1785
  callback?: string;
1631
1786
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1650,11 +1805,11 @@ declare namespace gapi.client {
1650
1805
  batchWrite(
1651
1806
  request: {
1652
1807
  /** V1 error format. */
1653
- '$.xgafv'?: string;
1808
+ '$.xgafv'?: '1' | '2';
1654
1809
  /** OAuth access token. */
1655
1810
  access_token?: string;
1656
1811
  /** Data format for response. */
1657
- alt?: string;
1812
+ alt?: 'json' | 'media' | 'proto';
1658
1813
  /** JSONP */
1659
1814
  callback?: string;
1660
1815
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1679,11 +1834,11 @@ declare namespace gapi.client {
1679
1834
  /** Starts a new transaction. */
1680
1835
  beginTransaction(request: {
1681
1836
  /** V1 error format. */
1682
- '$.xgafv'?: string;
1837
+ '$.xgafv'?: '1' | '2';
1683
1838
  /** OAuth access token. */
1684
1839
  access_token?: string;
1685
1840
  /** Data format for response. */
1686
- alt?: string;
1841
+ alt?: 'json' | 'media' | 'proto';
1687
1842
  /** JSONP */
1688
1843
  callback?: string;
1689
1844
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1708,11 +1863,11 @@ declare namespace gapi.client {
1708
1863
  beginTransaction(
1709
1864
  request: {
1710
1865
  /** V1 error format. */
1711
- '$.xgafv'?: string;
1866
+ '$.xgafv'?: '1' | '2';
1712
1867
  /** OAuth access token. */
1713
1868
  access_token?: string;
1714
1869
  /** Data format for response. */
1715
- alt?: string;
1870
+ alt?: 'json' | 'media' | 'proto';
1716
1871
  /** JSONP */
1717
1872
  callback?: string;
1718
1873
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1737,11 +1892,11 @@ declare namespace gapi.client {
1737
1892
  /** Commits a transaction, while optionally updating documents. */
1738
1893
  commit(request: {
1739
1894
  /** V1 error format. */
1740
- '$.xgafv'?: string;
1895
+ '$.xgafv'?: '1' | '2';
1741
1896
  /** OAuth access token. */
1742
1897
  access_token?: string;
1743
1898
  /** Data format for response. */
1744
- alt?: string;
1899
+ alt?: 'json' | 'media' | 'proto';
1745
1900
  /** JSONP */
1746
1901
  callback?: string;
1747
1902
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1766,11 +1921,11 @@ declare namespace gapi.client {
1766
1921
  commit(
1767
1922
  request: {
1768
1923
  /** V1 error format. */
1769
- '$.xgafv'?: string;
1924
+ '$.xgafv'?: '1' | '2';
1770
1925
  /** OAuth access token. */
1771
1926
  access_token?: string;
1772
1927
  /** Data format for response. */
1773
- alt?: string;
1928
+ alt?: 'json' | 'media' | 'proto';
1774
1929
  /** JSONP */
1775
1930
  callback?: string;
1776
1931
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1795,11 +1950,11 @@ declare namespace gapi.client {
1795
1950
  /** Creates a new document. */
1796
1951
  createDocument(request: {
1797
1952
  /** V1 error format. */
1798
- '$.xgafv'?: string;
1953
+ '$.xgafv'?: '1' | '2';
1799
1954
  /** OAuth access token. */
1800
1955
  access_token?: string;
1801
1956
  /** Data format for response. */
1802
- alt?: string;
1957
+ alt?: 'json' | 'media' | 'proto';
1803
1958
  /** JSONP */
1804
1959
  callback?: string;
1805
1960
  /** Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`. */
@@ -1830,11 +1985,11 @@ declare namespace gapi.client {
1830
1985
  createDocument(
1831
1986
  request: {
1832
1987
  /** V1 error format. */
1833
- '$.xgafv'?: string;
1988
+ '$.xgafv'?: '1' | '2';
1834
1989
  /** OAuth access token. */
1835
1990
  access_token?: string;
1836
1991
  /** Data format for response. */
1837
- alt?: string;
1992
+ alt?: 'json' | 'media' | 'proto';
1838
1993
  /** JSONP */
1839
1994
  callback?: string;
1840
1995
  /** Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`. */
@@ -1865,11 +2020,11 @@ declare namespace gapi.client {
1865
2020
  /** Deletes a document. */
1866
2021
  delete(request?: {
1867
2022
  /** V1 error format. */
1868
- '$.xgafv'?: string;
2023
+ '$.xgafv'?: '1' | '2';
1869
2024
  /** OAuth access token. */
1870
2025
  access_token?: string;
1871
2026
  /** Data format for response. */
1872
- alt?: string;
2027
+ alt?: 'json' | 'media' | 'proto';
1873
2028
  /** JSONP */
1874
2029
  callback?: string;
1875
2030
  /** When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */
@@ -1896,11 +2051,11 @@ declare namespace gapi.client {
1896
2051
  /** Executes a pipeline query. */
1897
2052
  executePipeline(request: {
1898
2053
  /** V1 error format. */
1899
- '$.xgafv'?: string;
2054
+ '$.xgafv'?: '1' | '2';
1900
2055
  /** OAuth access token. */
1901
2056
  access_token?: string;
1902
2057
  /** Data format for response. */
1903
- alt?: string;
2058
+ alt?: 'json' | 'media' | 'proto';
1904
2059
  /** JSONP */
1905
2060
  callback?: string;
1906
2061
  /** Required. Database identifier, in the form `projects/{project}/databases/{database}`. */
@@ -1925,11 +2080,11 @@ declare namespace gapi.client {
1925
2080
  executePipeline(
1926
2081
  request: {
1927
2082
  /** V1 error format. */
1928
- '$.xgafv'?: string;
2083
+ '$.xgafv'?: '1' | '2';
1929
2084
  /** OAuth access token. */
1930
2085
  access_token?: string;
1931
2086
  /** Data format for response. */
1932
- alt?: string;
2087
+ alt?: 'json' | 'media' | 'proto';
1933
2088
  /** JSONP */
1934
2089
  callback?: string;
1935
2090
  /** Required. Database identifier, in the form `projects/{project}/databases/{database}`. */
@@ -1954,11 +2109,11 @@ declare namespace gapi.client {
1954
2109
  /** Gets a single document. */
1955
2110
  get(request?: {
1956
2111
  /** V1 error format. */
1957
- '$.xgafv'?: string;
2112
+ '$.xgafv'?: '1' | '2';
1958
2113
  /** OAuth access token. */
1959
2114
  access_token?: string;
1960
2115
  /** Data format for response. */
1961
- alt?: string;
2116
+ alt?: 'json' | 'media' | 'proto';
1962
2117
  /** JSONP */
1963
2118
  callback?: string;
1964
2119
  /** Selector specifying which fields to include in a partial response. */
@@ -1987,11 +2142,11 @@ declare namespace gapi.client {
1987
2142
  /** Lists documents. */
1988
2143
  list(request?: {
1989
2144
  /** V1 error format. */
1990
- '$.xgafv'?: string;
2145
+ '$.xgafv'?: '1' | '2';
1991
2146
  /** OAuth access token. */
1992
2147
  access_token?: string;
1993
2148
  /** Data format for response. */
1994
- alt?: string;
2149
+ alt?: 'json' | 'media' | 'proto';
1995
2150
  /** JSONP */
1996
2151
  callback?: string;
1997
2152
  /** Optional. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. This is optional, and when not provided, Firestore will list documents from all collections under the provided `parent`. */
@@ -2030,11 +2185,11 @@ declare namespace gapi.client {
2030
2185
  /** Lists all the collection IDs underneath a document. */
2031
2186
  listCollectionIds(request: {
2032
2187
  /** V1 error format. */
2033
- '$.xgafv'?: string;
2188
+ '$.xgafv'?: '1' | '2';
2034
2189
  /** OAuth access token. */
2035
2190
  access_token?: string;
2036
2191
  /** Data format for response. */
2037
- alt?: string;
2192
+ alt?: 'json' | 'media' | 'proto';
2038
2193
  /** JSONP */
2039
2194
  callback?: string;
2040
2195
  /** Selector specifying which fields to include in a partial response. */
@@ -2043,7 +2198,7 @@ declare namespace gapi.client {
2043
2198
  key?: string;
2044
2199
  /** OAuth 2.0 token for the current user. */
2045
2200
  oauth_token?: string;
2046
- /** Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */
2201
+ /** Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` Use `projects/{project_id}/databases/{database_id}/documents` to list top-level collections. */
2047
2202
  parent: string;
2048
2203
  /** Returns response with indentations and line breaks. */
2049
2204
  prettyPrint?: boolean;
@@ -2059,11 +2214,11 @@ declare namespace gapi.client {
2059
2214
  listCollectionIds(
2060
2215
  request: {
2061
2216
  /** V1 error format. */
2062
- '$.xgafv'?: string;
2217
+ '$.xgafv'?: '1' | '2';
2063
2218
  /** OAuth access token. */
2064
2219
  access_token?: string;
2065
2220
  /** Data format for response. */
2066
- alt?: string;
2221
+ alt?: 'json' | 'media' | 'proto';
2067
2222
  /** JSONP */
2068
2223
  callback?: string;
2069
2224
  /** Selector specifying which fields to include in a partial response. */
@@ -2072,7 +2227,7 @@ declare namespace gapi.client {
2072
2227
  key?: string;
2073
2228
  /** OAuth 2.0 token for the current user. */
2074
2229
  oauth_token?: string;
2075
- /** Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */
2230
+ /** Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` Use `projects/{project_id}/databases/{database_id}/documents` to list top-level collections. */
2076
2231
  parent: string;
2077
2232
  /** Returns response with indentations and line breaks. */
2078
2233
  prettyPrint?: boolean;
@@ -2088,11 +2243,11 @@ declare namespace gapi.client {
2088
2243
  /** Lists documents. */
2089
2244
  listDocuments(request?: {
2090
2245
  /** V1 error format. */
2091
- '$.xgafv'?: string;
2246
+ '$.xgafv'?: '1' | '2';
2092
2247
  /** OAuth access token. */
2093
2248
  access_token?: string;
2094
2249
  /** Data format for response. */
2095
- alt?: string;
2250
+ alt?: 'json' | 'media' | 'proto';
2096
2251
  /** JSONP */
2097
2252
  callback?: string;
2098
2253
  /** Optional. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. This is optional, and when not provided, Firestore will list documents from all collections under the provided `parent`. */
@@ -2131,11 +2286,11 @@ declare namespace gapi.client {
2131
2286
  /** Listens to changes. This method is only available via gRPC or WebChannel (not REST). */
2132
2287
  listen(request: {
2133
2288
  /** V1 error format. */
2134
- '$.xgafv'?: string;
2289
+ '$.xgafv'?: '1' | '2';
2135
2290
  /** OAuth access token. */
2136
2291
  access_token?: string;
2137
2292
  /** Data format for response. */
2138
- alt?: string;
2293
+ alt?: 'json' | 'media' | 'proto';
2139
2294
  /** JSONP */
2140
2295
  callback?: string;
2141
2296
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -2160,11 +2315,11 @@ declare namespace gapi.client {
2160
2315
  listen(
2161
2316
  request: {
2162
2317
  /** V1 error format. */
2163
- '$.xgafv'?: string;
2318
+ '$.xgafv'?: '1' | '2';
2164
2319
  /** OAuth access token. */
2165
2320
  access_token?: string;
2166
2321
  /** Data format for response. */
2167
- alt?: string;
2322
+ alt?: 'json' | 'media' | 'proto';
2168
2323
  /** JSONP */
2169
2324
  callback?: string;
2170
2325
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -2189,11 +2344,11 @@ declare namespace gapi.client {
2189
2344
  /** Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results. */
2190
2345
  partitionQuery(request: {
2191
2346
  /** V1 error format. */
2192
- '$.xgafv'?: string;
2347
+ '$.xgafv'?: '1' | '2';
2193
2348
  /** OAuth access token. */
2194
2349
  access_token?: string;
2195
2350
  /** Data format for response. */
2196
- alt?: string;
2351
+ alt?: 'json' | 'media' | 'proto';
2197
2352
  /** JSONP */
2198
2353
  callback?: string;
2199
2354
  /** Selector specifying which fields to include in a partial response. */
@@ -2218,11 +2373,11 @@ declare namespace gapi.client {
2218
2373
  partitionQuery(
2219
2374
  request: {
2220
2375
  /** V1 error format. */
2221
- '$.xgafv'?: string;
2376
+ '$.xgafv'?: '1' | '2';
2222
2377
  /** OAuth access token. */
2223
2378
  access_token?: string;
2224
2379
  /** Data format for response. */
2225
- alt?: string;
2380
+ alt?: 'json' | 'media' | 'proto';
2226
2381
  /** JSONP */
2227
2382
  callback?: string;
2228
2383
  /** Selector specifying which fields to include in a partial response. */
@@ -2247,11 +2402,11 @@ declare namespace gapi.client {
2247
2402
  /** Updates or inserts a document. */
2248
2403
  patch(request: {
2249
2404
  /** V1 error format. */
2250
- '$.xgafv'?: string;
2405
+ '$.xgafv'?: '1' | '2';
2251
2406
  /** OAuth access token. */
2252
2407
  access_token?: string;
2253
2408
  /** Data format for response. */
2254
- alt?: string;
2409
+ alt?: 'json' | 'media' | 'proto';
2255
2410
  /** JSONP */
2256
2411
  callback?: string;
2257
2412
  /** When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */
@@ -2284,11 +2439,11 @@ declare namespace gapi.client {
2284
2439
  patch(
2285
2440
  request: {
2286
2441
  /** V1 error format. */
2287
- '$.xgafv'?: string;
2442
+ '$.xgafv'?: '1' | '2';
2288
2443
  /** OAuth access token. */
2289
2444
  access_token?: string;
2290
2445
  /** Data format for response. */
2291
- alt?: string;
2446
+ alt?: 'json' | 'media' | 'proto';
2292
2447
  /** JSONP */
2293
2448
  callback?: string;
2294
2449
  /** When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */
@@ -2321,11 +2476,11 @@ declare namespace gapi.client {
2321
2476
  /** Rolls back a transaction. */
2322
2477
  rollback(request: {
2323
2478
  /** V1 error format. */
2324
- '$.xgafv'?: string;
2479
+ '$.xgafv'?: '1' | '2';
2325
2480
  /** OAuth access token. */
2326
2481
  access_token?: string;
2327
2482
  /** Data format for response. */
2328
- alt?: string;
2483
+ alt?: 'json' | 'media' | 'proto';
2329
2484
  /** JSONP */
2330
2485
  callback?: string;
2331
2486
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -2350,11 +2505,11 @@ declare namespace gapi.client {
2350
2505
  rollback(
2351
2506
  request: {
2352
2507
  /** V1 error format. */
2353
- '$.xgafv'?: string;
2508
+ '$.xgafv'?: '1' | '2';
2354
2509
  /** OAuth access token. */
2355
2510
  access_token?: string;
2356
2511
  /** Data format for response. */
2357
- alt?: string;
2512
+ alt?: 'json' | 'media' | 'proto';
2358
2513
  /** JSONP */
2359
2514
  callback?: string;
2360
2515
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -2379,11 +2534,11 @@ declare namespace gapi.client {
2379
2534
  /** Runs an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side. High-Level Example: ``` -- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true ); ``` */
2380
2535
  runAggregationQuery(request: {
2381
2536
  /** V1 error format. */
2382
- '$.xgafv'?: string;
2537
+ '$.xgafv'?: '1' | '2';
2383
2538
  /** OAuth access token. */
2384
2539
  access_token?: string;
2385
2540
  /** Data format for response. */
2386
- alt?: string;
2541
+ alt?: 'json' | 'media' | 'proto';
2387
2542
  /** JSONP */
2388
2543
  callback?: string;
2389
2544
  /** Selector specifying which fields to include in a partial response. */
@@ -2408,11 +2563,11 @@ declare namespace gapi.client {
2408
2563
  runAggregationQuery(
2409
2564
  request: {
2410
2565
  /** V1 error format. */
2411
- '$.xgafv'?: string;
2566
+ '$.xgafv'?: '1' | '2';
2412
2567
  /** OAuth access token. */
2413
2568
  access_token?: string;
2414
2569
  /** Data format for response. */
2415
- alt?: string;
2570
+ alt?: 'json' | 'media' | 'proto';
2416
2571
  /** JSONP */
2417
2572
  callback?: string;
2418
2573
  /** Selector specifying which fields to include in a partial response. */
@@ -2437,11 +2592,11 @@ declare namespace gapi.client {
2437
2592
  /** Runs a query. */
2438
2593
  runQuery(request: {
2439
2594
  /** V1 error format. */
2440
- '$.xgafv'?: string;
2595
+ '$.xgafv'?: '1' | '2';
2441
2596
  /** OAuth access token. */
2442
2597
  access_token?: string;
2443
2598
  /** Data format for response. */
2444
- alt?: string;
2599
+ alt?: 'json' | 'media' | 'proto';
2445
2600
  /** JSONP */
2446
2601
  callback?: string;
2447
2602
  /** Selector specifying which fields to include in a partial response. */
@@ -2466,11 +2621,11 @@ declare namespace gapi.client {
2466
2621
  runQuery(
2467
2622
  request: {
2468
2623
  /** V1 error format. */
2469
- '$.xgafv'?: string;
2624
+ '$.xgafv'?: '1' | '2';
2470
2625
  /** OAuth access token. */
2471
2626
  access_token?: string;
2472
2627
  /** Data format for response. */
2473
- alt?: string;
2628
+ alt?: 'json' | 'media' | 'proto';
2474
2629
  /** JSONP */
2475
2630
  callback?: string;
2476
2631
  /** Selector specifying which fields to include in a partial response. */
@@ -2495,11 +2650,11 @@ declare namespace gapi.client {
2495
2650
  /** Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST). */
2496
2651
  write(request: {
2497
2652
  /** V1 error format. */
2498
- '$.xgafv'?: string;
2653
+ '$.xgafv'?: '1' | '2';
2499
2654
  /** OAuth access token. */
2500
2655
  access_token?: string;
2501
2656
  /** Data format for response. */
2502
- alt?: string;
2657
+ alt?: 'json' | 'media' | 'proto';
2503
2658
  /** JSONP */
2504
2659
  callback?: string;
2505
2660
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. */
@@ -2524,11 +2679,11 @@ declare namespace gapi.client {
2524
2679
  write(
2525
2680
  request: {
2526
2681
  /** V1 error format. */
2527
- '$.xgafv'?: string;
2682
+ '$.xgafv'?: '1' | '2';
2528
2683
  /** OAuth access token. */
2529
2684
  access_token?: string;
2530
2685
  /** Data format for response. */
2531
- alt?: string;
2686
+ alt?: 'json' | 'media' | 'proto';
2532
2687
  /** JSONP */
2533
2688
  callback?: string;
2534
2689
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. */
@@ -2555,11 +2710,11 @@ declare namespace gapi.client {
2555
2710
  /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
2556
2711
  cancel(request: {
2557
2712
  /** V1 error format. */
2558
- '$.xgafv'?: string;
2713
+ '$.xgafv'?: '1' | '2';
2559
2714
  /** OAuth access token. */
2560
2715
  access_token?: string;
2561
2716
  /** Data format for response. */
2562
- alt?: string;
2717
+ alt?: 'json' | 'media' | 'proto';
2563
2718
  /** JSONP */
2564
2719
  callback?: string;
2565
2720
  /** Selector specifying which fields to include in a partial response. */
@@ -2584,11 +2739,11 @@ declare namespace gapi.client {
2584
2739
  cancel(
2585
2740
  request: {
2586
2741
  /** V1 error format. */
2587
- '$.xgafv'?: string;
2742
+ '$.xgafv'?: '1' | '2';
2588
2743
  /** OAuth access token. */
2589
2744
  access_token?: string;
2590
2745
  /** Data format for response. */
2591
- alt?: string;
2746
+ alt?: 'json' | 'media' | 'proto';
2592
2747
  /** JSONP */
2593
2748
  callback?: string;
2594
2749
  /** Selector specifying which fields to include in a partial response. */
@@ -2613,11 +2768,11 @@ declare namespace gapi.client {
2613
2768
  /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
2614
2769
  delete(request?: {
2615
2770
  /** V1 error format. */
2616
- '$.xgafv'?: string;
2771
+ '$.xgafv'?: '1' | '2';
2617
2772
  /** OAuth access token. */
2618
2773
  access_token?: string;
2619
2774
  /** Data format for response. */
2620
- alt?: string;
2775
+ alt?: 'json' | 'media' | 'proto';
2621
2776
  /** JSONP */
2622
2777
  callback?: string;
2623
2778
  /** Selector specifying which fields to include in a partial response. */
@@ -2640,11 +2795,11 @@ declare namespace gapi.client {
2640
2795
  /** 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. */
2641
2796
  get(request?: {
2642
2797
  /** V1 error format. */
2643
- '$.xgafv'?: string;
2798
+ '$.xgafv'?: '1' | '2';
2644
2799
  /** OAuth access token. */
2645
2800
  access_token?: string;
2646
2801
  /** Data format for response. */
2647
- alt?: string;
2802
+ alt?: 'json' | 'media' | 'proto';
2648
2803
  /** JSONP */
2649
2804
  callback?: string;
2650
2805
  /** Selector specifying which fields to include in a partial response. */
@@ -2667,11 +2822,11 @@ declare namespace gapi.client {
2667
2822
  /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
2668
2823
  list(request?: {
2669
2824
  /** V1 error format. */
2670
- '$.xgafv'?: string;
2825
+ '$.xgafv'?: '1' | '2';
2671
2826
  /** OAuth access token. */
2672
2827
  access_token?: string;
2673
2828
  /** Data format for response. */
2674
- alt?: string;
2829
+ alt?: 'json' | 'media' | 'proto';
2675
2830
  /** JSONP */
2676
2831
  callback?: string;
2677
2832
  /** Selector specifying which fields to include in a partial response. */
@@ -2704,11 +2859,11 @@ declare namespace gapi.client {
2704
2859
  /** Create a user creds. */
2705
2860
  create(request: {
2706
2861
  /** V1 error format. */
2707
- '$.xgafv'?: string;
2862
+ '$.xgafv'?: '1' | '2';
2708
2863
  /** OAuth access token. */
2709
2864
  access_token?: string;
2710
2865
  /** Data format for response. */
2711
- alt?: string;
2866
+ alt?: 'json' | 'media' | 'proto';
2712
2867
  /** JSONP */
2713
2868
  callback?: string;
2714
2869
  /** Selector specifying which fields to include in a partial response. */
@@ -2735,11 +2890,11 @@ declare namespace gapi.client {
2735
2890
  create(
2736
2891
  request: {
2737
2892
  /** V1 error format. */
2738
- '$.xgafv'?: string;
2893
+ '$.xgafv'?: '1' | '2';
2739
2894
  /** OAuth access token. */
2740
2895
  access_token?: string;
2741
2896
  /** Data format for response. */
2742
- alt?: string;
2897
+ alt?: 'json' | 'media' | 'proto';
2743
2898
  /** JSONP */
2744
2899
  callback?: string;
2745
2900
  /** Selector specifying which fields to include in a partial response. */
@@ -2766,11 +2921,11 @@ declare namespace gapi.client {
2766
2921
  /** Deletes a user creds. */
2767
2922
  delete(request?: {
2768
2923
  /** V1 error format. */
2769
- '$.xgafv'?: string;
2924
+ '$.xgafv'?: '1' | '2';
2770
2925
  /** OAuth access token. */
2771
2926
  access_token?: string;
2772
2927
  /** Data format for response. */
2773
- alt?: string;
2928
+ alt?: 'json' | 'media' | 'proto';
2774
2929
  /** JSONP */
2775
2930
  callback?: string;
2776
2931
  /** Selector specifying which fields to include in a partial response. */
@@ -2793,11 +2948,11 @@ declare namespace gapi.client {
2793
2948
  /** Disables a user creds. No-op if the user creds are already disabled. */
2794
2949
  disable(request: {
2795
2950
  /** V1 error format. */
2796
- '$.xgafv'?: string;
2951
+ '$.xgafv'?: '1' | '2';
2797
2952
  /** OAuth access token. */
2798
2953
  access_token?: string;
2799
2954
  /** Data format for response. */
2800
- alt?: string;
2955
+ alt?: 'json' | 'media' | 'proto';
2801
2956
  /** JSONP */
2802
2957
  callback?: string;
2803
2958
  /** Selector specifying which fields to include in a partial response. */
@@ -2822,11 +2977,11 @@ declare namespace gapi.client {
2822
2977
  disable(
2823
2978
  request: {
2824
2979
  /** V1 error format. */
2825
- '$.xgafv'?: string;
2980
+ '$.xgafv'?: '1' | '2';
2826
2981
  /** OAuth access token. */
2827
2982
  access_token?: string;
2828
2983
  /** Data format for response. */
2829
- alt?: string;
2984
+ alt?: 'json' | 'media' | 'proto';
2830
2985
  /** JSONP */
2831
2986
  callback?: string;
2832
2987
  /** Selector specifying which fields to include in a partial response. */
@@ -2851,11 +3006,11 @@ declare namespace gapi.client {
2851
3006
  /** Enables a user creds. No-op if the user creds are already enabled. */
2852
3007
  enable(request: {
2853
3008
  /** V1 error format. */
2854
- '$.xgafv'?: string;
3009
+ '$.xgafv'?: '1' | '2';
2855
3010
  /** OAuth access token. */
2856
3011
  access_token?: string;
2857
3012
  /** Data format for response. */
2858
- alt?: string;
3013
+ alt?: 'json' | 'media' | 'proto';
2859
3014
  /** JSONP */
2860
3015
  callback?: string;
2861
3016
  /** Selector specifying which fields to include in a partial response. */
@@ -2880,11 +3035,11 @@ declare namespace gapi.client {
2880
3035
  enable(
2881
3036
  request: {
2882
3037
  /** V1 error format. */
2883
- '$.xgafv'?: string;
3038
+ '$.xgafv'?: '1' | '2';
2884
3039
  /** OAuth access token. */
2885
3040
  access_token?: string;
2886
3041
  /** Data format for response. */
2887
- alt?: string;
3042
+ alt?: 'json' | 'media' | 'proto';
2888
3043
  /** JSONP */
2889
3044
  callback?: string;
2890
3045
  /** Selector specifying which fields to include in a partial response. */
@@ -2909,11 +3064,11 @@ declare namespace gapi.client {
2909
3064
  /** Gets a user creds resource. Note that the returned resource does not contain the secret value itself. */
2910
3065
  get(request?: {
2911
3066
  /** V1 error format. */
2912
- '$.xgafv'?: string;
3067
+ '$.xgafv'?: '1' | '2';
2913
3068
  /** OAuth access token. */
2914
3069
  access_token?: string;
2915
3070
  /** Data format for response. */
2916
- alt?: string;
3071
+ alt?: 'json' | 'media' | 'proto';
2917
3072
  /** JSONP */
2918
3073
  callback?: string;
2919
3074
  /** Selector specifying which fields to include in a partial response. */
@@ -2936,11 +3091,11 @@ declare namespace gapi.client {
2936
3091
  /** List all user creds in the database. Note that the returned resource does not contain the secret value itself. */
2937
3092
  list(request?: {
2938
3093
  /** V1 error format. */
2939
- '$.xgafv'?: string;
3094
+ '$.xgafv'?: '1' | '2';
2940
3095
  /** OAuth access token. */
2941
3096
  access_token?: string;
2942
3097
  /** Data format for response. */
2943
- alt?: string;
3098
+ alt?: 'json' | 'media' | 'proto';
2944
3099
  /** JSONP */
2945
3100
  callback?: string;
2946
3101
  /** Selector specifying which fields to include in a partial response. */
@@ -2963,11 +3118,11 @@ declare namespace gapi.client {
2963
3118
  /** Resets the password of a user creds. */
2964
3119
  resetPassword(request: {
2965
3120
  /** V1 error format. */
2966
- '$.xgafv'?: string;
3121
+ '$.xgafv'?: '1' | '2';
2967
3122
  /** OAuth access token. */
2968
3123
  access_token?: string;
2969
3124
  /** Data format for response. */
2970
- alt?: string;
3125
+ alt?: 'json' | 'media' | 'proto';
2971
3126
  /** JSONP */
2972
3127
  callback?: string;
2973
3128
  /** Selector specifying which fields to include in a partial response. */
@@ -2992,11 +3147,11 @@ declare namespace gapi.client {
2992
3147
  resetPassword(
2993
3148
  request: {
2994
3149
  /** V1 error format. */
2995
- '$.xgafv'?: string;
3150
+ '$.xgafv'?: '1' | '2';
2996
3151
  /** OAuth access token. */
2997
3152
  access_token?: string;
2998
3153
  /** Data format for response. */
2999
- alt?: string;
3154
+ alt?: 'json' | 'media' | 'proto';
3000
3155
  /** JSONP */
3001
3156
  callback?: string;
3002
3157
  /** Selector specifying which fields to include in a partial response. */
@@ -3023,11 +3178,11 @@ declare namespace gapi.client {
3023
3178
  /** Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created. For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete */
3024
3179
  bulkDeleteDocuments(request: {
3025
3180
  /** V1 error format. */
3026
- '$.xgafv'?: string;
3181
+ '$.xgafv'?: '1' | '2';
3027
3182
  /** OAuth access token. */
3028
3183
  access_token?: string;
3029
3184
  /** Data format for response. */
3030
- alt?: string;
3185
+ alt?: 'json' | 'media' | 'proto';
3031
3186
  /** JSONP */
3032
3187
  callback?: string;
3033
3188
  /** Selector specifying which fields to include in a partial response. */
@@ -3052,11 +3207,11 @@ declare namespace gapi.client {
3052
3207
  bulkDeleteDocuments(
3053
3208
  request: {
3054
3209
  /** V1 error format. */
3055
- '$.xgafv'?: string;
3210
+ '$.xgafv'?: '1' | '2';
3056
3211
  /** OAuth access token. */
3057
3212
  access_token?: string;
3058
3213
  /** Data format for response. */
3059
- alt?: string;
3214
+ alt?: 'json' | 'media' | 'proto';
3060
3215
  /** JSONP */
3061
3216
  callback?: string;
3062
3217
  /** Selector specifying which fields to include in a partial response. */
@@ -3081,11 +3236,11 @@ declare namespace gapi.client {
3081
3236
  /** Creates a new database by cloning an existing one. The new database must be in the same cloud region or multi-region location as the existing database. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing database. The long-running operation can be used to track the progress of the clone, with the Operation's metadata field type being the CloneDatabaseMetadata. The response type is the Database if the clone was successful. The new database is not readable or writeable until the LRO has completed. */
3082
3237
  clone(request: {
3083
3238
  /** V1 error format. */
3084
- '$.xgafv'?: string;
3239
+ '$.xgafv'?: '1' | '2';
3085
3240
  /** OAuth access token. */
3086
3241
  access_token?: string;
3087
3242
  /** Data format for response. */
3088
- alt?: string;
3243
+ alt?: 'json' | 'media' | 'proto';
3089
3244
  /** JSONP */
3090
3245
  callback?: string;
3091
3246
  /** Selector specifying which fields to include in a partial response. */
@@ -3110,11 +3265,11 @@ declare namespace gapi.client {
3110
3265
  clone(
3111
3266
  request: {
3112
3267
  /** V1 error format. */
3113
- '$.xgafv'?: string;
3268
+ '$.xgafv'?: '1' | '2';
3114
3269
  /** OAuth access token. */
3115
3270
  access_token?: string;
3116
3271
  /** Data format for response. */
3117
- alt?: string;
3272
+ alt?: 'json' | 'media' | 'proto';
3118
3273
  /** JSONP */
3119
3274
  callback?: string;
3120
3275
  /** Selector specifying which fields to include in a partial response. */
@@ -3139,11 +3294,11 @@ declare namespace gapi.client {
3139
3294
  /** Create a database. */
3140
3295
  create(request: {
3141
3296
  /** V1 error format. */
3142
- '$.xgafv'?: string;
3297
+ '$.xgafv'?: '1' | '2';
3143
3298
  /** OAuth access token. */
3144
3299
  access_token?: string;
3145
3300
  /** Data format for response. */
3146
- alt?: string;
3301
+ alt?: 'json' | 'media' | 'proto';
3147
3302
  /** JSONP */
3148
3303
  callback?: string;
3149
3304
  /** Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid if the database is Standard edition. */
@@ -3170,11 +3325,11 @@ declare namespace gapi.client {
3170
3325
  create(
3171
3326
  request: {
3172
3327
  /** V1 error format. */
3173
- '$.xgafv'?: string;
3328
+ '$.xgafv'?: '1' | '2';
3174
3329
  /** OAuth access token. */
3175
3330
  access_token?: string;
3176
3331
  /** Data format for response. */
3177
- alt?: string;
3332
+ alt?: 'json' | 'media' | 'proto';
3178
3333
  /** JSONP */
3179
3334
  callback?: string;
3180
3335
  /** Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid if the database is Standard edition. */
@@ -3201,11 +3356,11 @@ declare namespace gapi.client {
3201
3356
  /** Deletes a database. */
3202
3357
  delete(request?: {
3203
3358
  /** V1 error format. */
3204
- '$.xgafv'?: string;
3359
+ '$.xgafv'?: '1' | '2';
3205
3360
  /** OAuth access token. */
3206
3361
  access_token?: string;
3207
3362
  /** Data format for response. */
3208
- alt?: string;
3363
+ alt?: 'json' | 'media' | 'proto';
3209
3364
  /** JSONP */
3210
3365
  callback?: string;
3211
3366
  /** The current etag of the Database. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned. */
@@ -3230,11 +3385,11 @@ declare namespace gapi.client {
3230
3385
  /** Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import */
3231
3386
  exportDocuments(request: {
3232
3387
  /** V1 error format. */
3233
- '$.xgafv'?: string;
3388
+ '$.xgafv'?: '1' | '2';
3234
3389
  /** OAuth access token. */
3235
3390
  access_token?: string;
3236
3391
  /** Data format for response. */
3237
- alt?: string;
3392
+ alt?: 'json' | 'media' | 'proto';
3238
3393
  /** JSONP */
3239
3394
  callback?: string;
3240
3395
  /** Selector specifying which fields to include in a partial response. */
@@ -3259,11 +3414,11 @@ declare namespace gapi.client {
3259
3414
  exportDocuments(
3260
3415
  request: {
3261
3416
  /** V1 error format. */
3262
- '$.xgafv'?: string;
3417
+ '$.xgafv'?: '1' | '2';
3263
3418
  /** OAuth access token. */
3264
3419
  access_token?: string;
3265
3420
  /** Data format for response. */
3266
- alt?: string;
3421
+ alt?: 'json' | 'media' | 'proto';
3267
3422
  /** JSONP */
3268
3423
  callback?: string;
3269
3424
  /** Selector specifying which fields to include in a partial response. */
@@ -3288,11 +3443,11 @@ declare namespace gapi.client {
3288
3443
  /** Gets information about a database. */
3289
3444
  get(request?: {
3290
3445
  /** V1 error format. */
3291
- '$.xgafv'?: string;
3446
+ '$.xgafv'?: '1' | '2';
3292
3447
  /** OAuth access token. */
3293
3448
  access_token?: string;
3294
3449
  /** Data format for response. */
3295
- alt?: string;
3450
+ alt?: 'json' | 'media' | 'proto';
3296
3451
  /** JSONP */
3297
3452
  callback?: string;
3298
3453
  /** Selector specifying which fields to include in a partial response. */
@@ -3315,11 +3470,11 @@ declare namespace gapi.client {
3315
3470
  /** Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore. */
3316
3471
  importDocuments(request: {
3317
3472
  /** V1 error format. */
3318
- '$.xgafv'?: string;
3473
+ '$.xgafv'?: '1' | '2';
3319
3474
  /** OAuth access token. */
3320
3475
  access_token?: string;
3321
3476
  /** Data format for response. */
3322
- alt?: string;
3477
+ alt?: 'json' | 'media' | 'proto';
3323
3478
  /** JSONP */
3324
3479
  callback?: string;
3325
3480
  /** Selector specifying which fields to include in a partial response. */
@@ -3344,11 +3499,11 @@ declare namespace gapi.client {
3344
3499
  importDocuments(
3345
3500
  request: {
3346
3501
  /** V1 error format. */
3347
- '$.xgafv'?: string;
3502
+ '$.xgafv'?: '1' | '2';
3348
3503
  /** OAuth access token. */
3349
3504
  access_token?: string;
3350
3505
  /** Data format for response. */
3351
- alt?: string;
3506
+ alt?: 'json' | 'media' | 'proto';
3352
3507
  /** JSONP */
3353
3508
  callback?: string;
3354
3509
  /** Selector specifying which fields to include in a partial response. */
@@ -3373,11 +3528,11 @@ declare namespace gapi.client {
3373
3528
  /** List all the databases in the project. */
3374
3529
  list(request?: {
3375
3530
  /** V1 error format. */
3376
- '$.xgafv'?: string;
3531
+ '$.xgafv'?: '1' | '2';
3377
3532
  /** OAuth access token. */
3378
3533
  access_token?: string;
3379
3534
  /** Data format for response. */
3380
- alt?: string;
3535
+ alt?: 'json' | 'media' | 'proto';
3381
3536
  /** JSONP */
3382
3537
  callback?: string;
3383
3538
  /** Selector specifying which fields to include in a partial response. */
@@ -3402,11 +3557,11 @@ declare namespace gapi.client {
3402
3557
  /** Updates a database. */
3403
3558
  patch(request: {
3404
3559
  /** V1 error format. */
3405
- '$.xgafv'?: string;
3560
+ '$.xgafv'?: '1' | '2';
3406
3561
  /** OAuth access token. */
3407
3562
  access_token?: string;
3408
3563
  /** Data format for response. */
3409
- alt?: string;
3564
+ alt?: 'json' | 'media' | 'proto';
3410
3565
  /** JSONP */
3411
3566
  callback?: string;
3412
3567
  /** Selector specifying which fields to include in a partial response. */
@@ -3433,11 +3588,11 @@ declare namespace gapi.client {
3433
3588
  patch(
3434
3589
  request: {
3435
3590
  /** V1 error format. */
3436
- '$.xgafv'?: string;
3591
+ '$.xgafv'?: '1' | '2';
3437
3592
  /** OAuth access token. */
3438
3593
  access_token?: string;
3439
3594
  /** Data format for response. */
3440
- alt?: string;
3595
+ alt?: 'json' | 'media' | 'proto';
3441
3596
  /** JSONP */
3442
3597
  callback?: string;
3443
3598
  /** Selector specifying which fields to include in a partial response. */
@@ -3464,11 +3619,11 @@ declare namespace gapi.client {
3464
3619
  /** Creates a new database by restoring from an existing backup. The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup. The long-running operation can be used to track the progress of the restore, with the Operation's metadata field type being the RestoreDatabaseMetadata. The response type is the Database if the restore was successful. The new database is not readable or writeable until the LRO has completed. */
3465
3620
  restore(request: {
3466
3621
  /** V1 error format. */
3467
- '$.xgafv'?: string;
3622
+ '$.xgafv'?: '1' | '2';
3468
3623
  /** OAuth access token. */
3469
3624
  access_token?: string;
3470
3625
  /** Data format for response. */
3471
- alt?: string;
3626
+ alt?: 'json' | 'media' | 'proto';
3472
3627
  /** JSONP */
3473
3628
  callback?: string;
3474
3629
  /** Selector specifying which fields to include in a partial response. */
@@ -3493,11 +3648,11 @@ declare namespace gapi.client {
3493
3648
  restore(
3494
3649
  request: {
3495
3650
  /** V1 error format. */
3496
- '$.xgafv'?: string;
3651
+ '$.xgafv'?: '1' | '2';
3497
3652
  /** OAuth access token. */
3498
3653
  access_token?: string;
3499
3654
  /** Data format for response. */
3500
- alt?: string;
3655
+ alt?: 'json' | 'media' | 'proto';
3501
3656
  /** JSONP */
3502
3657
  callback?: string;
3503
3658
  /** Selector specifying which fields to include in a partial response. */
@@ -3529,11 +3684,11 @@ declare namespace gapi.client {
3529
3684
  /** Deletes a backup. */
3530
3685
  delete(request?: {
3531
3686
  /** V1 error format. */
3532
- '$.xgafv'?: string;
3687
+ '$.xgafv'?: '1' | '2';
3533
3688
  /** OAuth access token. */
3534
3689
  access_token?: string;
3535
3690
  /** Data format for response. */
3536
- alt?: string;
3691
+ alt?: 'json' | 'media' | 'proto';
3537
3692
  /** JSONP */
3538
3693
  callback?: string;
3539
3694
  /** Selector specifying which fields to include in a partial response. */
@@ -3556,11 +3711,11 @@ declare namespace gapi.client {
3556
3711
  /** Gets information about a backup. */
3557
3712
  get(request?: {
3558
3713
  /** V1 error format. */
3559
- '$.xgafv'?: string;
3714
+ '$.xgafv'?: '1' | '2';
3560
3715
  /** OAuth access token. */
3561
3716
  access_token?: string;
3562
3717
  /** Data format for response. */
3563
- alt?: string;
3718
+ alt?: 'json' | 'media' | 'proto';
3564
3719
  /** JSONP */
3565
3720
  callback?: string;
3566
3721
  /** Selector specifying which fields to include in a partial response. */
@@ -3583,11 +3738,11 @@ declare namespace gapi.client {
3583
3738
  /** Lists all the backups. */
3584
3739
  list(request?: {
3585
3740
  /** V1 error format. */
3586
- '$.xgafv'?: string;
3741
+ '$.xgafv'?: '1' | '2';
3587
3742
  /** OAuth access token. */
3588
3743
  access_token?: string;
3589
3744
  /** Data format for response. */
3590
- alt?: string;
3745
+ alt?: 'json' | 'media' | 'proto';
3591
3746
  /** JSONP */
3592
3747
  callback?: string;
3593
3748
  /** Selector specifying which fields to include in a partial response. */
@@ -3614,11 +3769,11 @@ declare namespace gapi.client {
3614
3769
  /** Gets information about a location. */
3615
3770
  get(request?: {
3616
3771
  /** V1 error format. */
3617
- '$.xgafv'?: string;
3772
+ '$.xgafv'?: '1' | '2';
3618
3773
  /** OAuth access token. */
3619
3774
  access_token?: string;
3620
3775
  /** Data format for response. */
3621
- alt?: string;
3776
+ alt?: 'json' | 'media' | 'proto';
3622
3777
  /** JSONP */
3623
3778
  callback?: string;
3624
3779
  /** Selector specifying which fields to include in a partial response. */
@@ -3638,17 +3793,17 @@ declare namespace gapi.client {
3638
3793
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3639
3794
  uploadType?: string;
3640
3795
  }): Request<Location>;
3641
- /** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
3796
+ /** Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. */
3642
3797
  list(request?: {
3643
3798
  /** V1 error format. */
3644
- '$.xgafv'?: string;
3799
+ '$.xgafv'?: '1' | '2';
3645
3800
  /** OAuth access token. */
3646
3801
  access_token?: string;
3647
3802
  /** Data format for response. */
3648
- alt?: string;
3803
+ alt?: 'json' | 'media' | 'proto';
3649
3804
  /** JSONP */
3650
3805
  callback?: string;
3651
- /** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
3806
+ /** Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */
3652
3807
  extraLocationTypes?: string | string[];
3653
3808
  /** Selector specifying which fields to include in a partial response. */
3654
3809
  fields?: string;