@maxim_mazurok/gapi.client.firestore-v1 0.3.20260702 → 0.3.20260810

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 (2) hide show
  1. package/index.d.ts +199 -9
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://firestore.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20260702
12
+ // Revision: 20260810
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -383,6 +383,24 @@ declare namespace gapi.client {
383
383
  /** Optional. Namespaces to delete. An empty list means all namespaces. This is the recommended usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to delete from them. Each namespace in this list must be unique. */
384
384
  namespaceIds?: string[];
385
385
  }
386
+ interface GoogleFirestoreAdminV1ChangeStream {
387
+ /** If set, the change stream is scoped to a collection group. */
388
+ collectionGroupScope?: GoogleFirestoreAdminV1CollectionGroupScope;
389
+ /** Output only. The time the Change Stream was created. */
390
+ createTime?: string;
391
+ /** If set, the change stream is scoped to the entire database. */
392
+ databaseScope?: any;
393
+ /** Optional. An etag used to determine which version of the configuration is being edited. */
394
+ etag?: string;
395
+ /** Identifier. The external resource name of the change stream. Format `projects/{project}/databases/{database}/changeStreams/{change_stream}` */
396
+ name?: string;
397
+ /** Required. The retention period of the change stream. This is the amount of time a change event is available on the change stream. Must be from 1 to 7 days, inclusive. The retention_period must be in day granularity, i.e. it must be a multiple of 24 hours. */
398
+ retentionPeriod?: string;
399
+ /** Output only. The time the Change Stream started recording events. */
400
+ startTime?: string;
401
+ /** Output only. The time the Change Stream was last updated. */
402
+ updateTime?: string;
403
+ }
386
404
  interface GoogleFirestoreAdminV1CloneDatabaseMetadata {
387
405
  /** The name of the database being cloned to. */
388
406
  database?: string;
@@ -421,6 +439,10 @@ declare namespace gapi.client {
421
439
  /** Required. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. */
422
440
  kmsKeyName?: string;
423
441
  }
442
+ interface GoogleFirestoreAdminV1CollectionGroupScope {
443
+ /** Required. The collection group name. */
444
+ collectionGroupId?: string;
445
+ }
424
446
  interface GoogleFirestoreAdminV1CreateDatabaseMetadata {}
425
447
  interface GoogleFirestoreAdminV1CustomerManagedEncryptionOptions {
426
448
  /** Required. Only keys in the same location as the database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. */
@@ -455,7 +477,7 @@ declare namespace gapi.client {
455
477
  earliestVersionTime?: string;
456
478
  /** 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. */
457
479
  etag?: string;
458
- /** 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. */
480
+ /** 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. */
459
481
  firestoreDataAccessMode?:
460
482
  | 'DATA_ACCESS_MODE_UNSPECIFIED'
461
483
  | 'DATA_ACCESS_MODE_ENABLED'
@@ -466,7 +488,7 @@ declare namespace gapi.client {
466
488
  keyPrefix?: string;
467
489
  /** Required. The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. */
468
490
  locationId?: string;
469
- /** 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. */
491
+ /** 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. */
470
492
  mongodbCompatibleDataAccessMode?:
471
493
  | 'DATA_ACCESS_MODE_UNSPECIFIED'
472
494
  | 'DATA_ACCESS_MODE_ENABLED'
@@ -499,6 +521,7 @@ declare namespace gapi.client {
499
521
  /** Output only. The period during which past versions of data are retained in the database. Any read or query can specify a `read_time` within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. */
500
522
  versionRetentionPeriod?: string;
501
523
  }
524
+ interface GoogleFirestoreAdminV1DatabaseScope {}
502
525
  interface GoogleFirestoreAdminV1DeleteDatabaseMetadata {}
503
526
  interface GoogleFirestoreAdminV1DisableUserCredsRequest {}
504
527
  interface GoogleFirestoreAdminV1EnableUserCredsRequest {}
@@ -627,11 +650,11 @@ declare namespace gapi.client {
627
650
  apiScope?: 'ANY_API' | 'DATASTORE_MODE_API' | 'MONGODB_COMPATIBLE_API';
628
651
  /** Immutable. The density configuration of the index. */
629
652
  density?: 'DENSITY_UNSPECIFIED' | 'SPARSE_ALL' | 'SPARSE_ANY' | 'DENSE';
630
- /** 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. */
653
+ /** The fields supported by this index. At most 100 fields may be specified. In Standard edition databases only: - At least 2 fields must be specified. - 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 the index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). */
631
654
  fields?: GoogleFirestoreAdminV1IndexField[];
632
655
  /** 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. */
633
656
  multikey?: boolean;
634
- /** 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. */
657
+ /** A server-defined name for this index. Output only. When used in the google.firestore.admin.v1.Index resource, the value is of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` When used in the google.firestore.admin.v1.Field resource, the value is empty. */
635
658
  name?: string;
636
659
  /** 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. */
637
660
  queryScope?:
@@ -708,6 +731,10 @@ declare namespace gapi.client {
708
731
  /** List of locations that existing backups were not able to be fetched from. Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error. */
709
732
  unreachable?: string[];
710
733
  }
734
+ interface GoogleFirestoreAdminV1ListChangeStreamsResponse {
735
+ /** The list of change streams. */
736
+ changeStreams?: GoogleFirestoreAdminV1ChangeStream[];
737
+ }
711
738
  interface GoogleFirestoreAdminV1ListDatabasesResponse {
712
739
  /** The databases in the project. */
713
740
  databases?: GoogleFirestoreAdminV1Database[];
@@ -835,7 +862,22 @@ declare namespace gapi.client {
835
862
  /** The offset, relative to the timestamp value in the TTL-enabled field, used determine the document's expiration time. */
836
863
  expirationOffset?: string;
837
864
  }
838
- interface GoogleFirestoreAdminV1UpdateDatabaseMetadata {}
865
+ interface GoogleFirestoreAdminV1UpdateDatabaseMetadata {
866
+ /** The time this operation completed. Will be unset if operation still in progress. */
867
+ endTime?: string;
868
+ /** The time this operation started. */
869
+ startTime?: string;
870
+ /** The state of the operation. */
871
+ state?:
872
+ | 'OPERATION_STATE_UNSPECIFIED'
873
+ | 'INITIALIZING'
874
+ | 'PROCESSING'
875
+ | 'CANCELLING'
876
+ | 'FINALIZING'
877
+ | 'SUCCESSFUL'
878
+ | 'FAILED'
879
+ | 'CANCELLED';
880
+ }
839
881
  interface GoogleFirestoreAdminV1UserCreds {
840
882
  /** Output only. The time the user creds were created. */
841
883
  createTime?: string;
@@ -1182,11 +1224,11 @@ declare namespace gapi.client {
1182
1224
  | 'IS_NOT_NULL';
1183
1225
  }
1184
1226
  interface Value {
1185
- /** An array value. Cannot directly contain another array value, though can contain a map which contains another array. */
1227
+ /** An array value. In Standard edition databases, an array value cannot directly contain another array value, though it can contain a map which contains another array. In Enterprise edition databases, an array value can contain another array value. */
1186
1228
  arrayValue?: ArrayValue;
1187
1229
  /** A boolean value. */
1188
1230
  booleanValue?: boolean;
1189
- /** A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. */
1231
+ /** A bytes value. In Standard edition databases: * The value must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits. */
1190
1232
  bytesValue?: string;
1191
1233
  /** A double value. */
1192
1234
  doubleValue?: number;
@@ -1206,7 +1248,7 @@ declare namespace gapi.client {
1206
1248
  pipelineValue?: Pipeline;
1207
1249
  /** A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */
1208
1250
  referenceValue?: string;
1209
- /** A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. */
1251
+ /** A string value. In Standard edition databases: * The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes of the UTF-8 representation are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits. */
1210
1252
  stringValue?: string;
1211
1253
  /** A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. */
1212
1254
  timestampValue?: string;
@@ -1458,6 +1500,153 @@ declare namespace gapi.client {
1458
1500
  body: GoogleFirestoreAdminV1BackupSchedule,
1459
1501
  ): Request<GoogleFirestoreAdminV1BackupSchedule>;
1460
1502
  }
1503
+ interface ChangeStreamsResource {
1504
+ /** Creates a new change stream for the database. */
1505
+ create(request: {
1506
+ /** V1 error format. */
1507
+ '$.xgafv'?: '1' | '2';
1508
+ /** OAuth access token. */
1509
+ access_token?: string;
1510
+ /** Data format for response. */
1511
+ alt?: 'json' | 'media' | 'proto';
1512
+ /** JSONP */
1513
+ callback?: string;
1514
+ /** Required. The ID to use for the change stream, which will become the final component of the change stream's resource name. This value should be 4-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a letter, and the last character must be a letter or a number. */
1515
+ changeStreamId?: string;
1516
+ /** Selector specifying which fields to include in a partial response. */
1517
+ fields?: string;
1518
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1519
+ key?: string;
1520
+ /** OAuth 2.0 token for the current user. */
1521
+ oauth_token?: string;
1522
+ /** Required. The parent database to create the change stream for. Format is `projects/{project}/databases/{database}`. */
1523
+ parent: string;
1524
+ /** Returns response with indentations and line breaks. */
1525
+ prettyPrint?: boolean;
1526
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1527
+ quotaUser?: string;
1528
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1529
+ upload_protocol?: string;
1530
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1531
+ uploadType?: string;
1532
+ /** Request body */
1533
+ resource: GoogleFirestoreAdminV1ChangeStream;
1534
+ }): Request<GoogleFirestoreAdminV1ChangeStream>;
1535
+ create(
1536
+ request: {
1537
+ /** V1 error format. */
1538
+ '$.xgafv'?: '1' | '2';
1539
+ /** OAuth access token. */
1540
+ access_token?: string;
1541
+ /** Data format for response. */
1542
+ alt?: 'json' | 'media' | 'proto';
1543
+ /** JSONP */
1544
+ callback?: string;
1545
+ /** Required. The ID to use for the change stream, which will become the final component of the change stream's resource name. This value should be 4-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a letter, and the last character must be a letter or a number. */
1546
+ changeStreamId?: string;
1547
+ /** Selector specifying which fields to include in a partial response. */
1548
+ fields?: string;
1549
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1550
+ key?: string;
1551
+ /** OAuth 2.0 token for the current user. */
1552
+ oauth_token?: string;
1553
+ /** Required. The parent database to create the change stream for. Format is `projects/{project}/databases/{database}`. */
1554
+ parent: string;
1555
+ /** Returns response with indentations and line breaks. */
1556
+ prettyPrint?: boolean;
1557
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1558
+ quotaUser?: string;
1559
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1560
+ upload_protocol?: string;
1561
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1562
+ uploadType?: string;
1563
+ },
1564
+ body: GoogleFirestoreAdminV1ChangeStream,
1565
+ ): Request<GoogleFirestoreAdminV1ChangeStream>;
1566
+ /** Deletes a change stream. */
1567
+ delete(request?: {
1568
+ /** V1 error format. */
1569
+ '$.xgafv'?: '1' | '2';
1570
+ /** OAuth access token. */
1571
+ access_token?: string;
1572
+ /** Data format for response. */
1573
+ alt?: 'json' | 'media' | 'proto';
1574
+ /** JSONP */
1575
+ callback?: string;
1576
+ /** Optional. The etag of the change stream to delete. If this is not the current etag of the change stream, the deletion will fail. */
1577
+ etag?: string;
1578
+ /** Selector specifying which fields to include in a partial response. */
1579
+ fields?: string;
1580
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1581
+ key?: string;
1582
+ /** Required. The name of the change stream to delete. Format is `projects/{project}/databases/{database}/changeStreams/{change_stream}`. */
1583
+ name: string;
1584
+ /** OAuth 2.0 token for the current user. */
1585
+ oauth_token?: string;
1586
+ /** Returns response with indentations and line breaks. */
1587
+ prettyPrint?: boolean;
1588
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1589
+ quotaUser?: string;
1590
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1591
+ upload_protocol?: string;
1592
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1593
+ uploadType?: string;
1594
+ }): Request<{}>;
1595
+ /** Gets information about a change stream. */
1596
+ get(request?: {
1597
+ /** V1 error format. */
1598
+ '$.xgafv'?: '1' | '2';
1599
+ /** OAuth access token. */
1600
+ access_token?: string;
1601
+ /** Data format for response. */
1602
+ alt?: 'json' | 'media' | 'proto';
1603
+ /** JSONP */
1604
+ callback?: string;
1605
+ /** Selector specifying which fields to include in a partial response. */
1606
+ fields?: string;
1607
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1608
+ key?: string;
1609
+ /** Required. The name of the change stream to retrieve. Format is `projects/{project}/databases/{database}/changeStreams/{change_stream}`. */
1610
+ name: string;
1611
+ /** OAuth 2.0 token for the current user. */
1612
+ oauth_token?: string;
1613
+ /** Returns response with indentations and line breaks. */
1614
+ prettyPrint?: boolean;
1615
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1616
+ quotaUser?: string;
1617
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1618
+ upload_protocol?: string;
1619
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1620
+ uploadType?: string;
1621
+ }): Request<GoogleFirestoreAdminV1ChangeStream>;
1622
+ /** Lists all change streams in a database. */
1623
+ list(request?: {
1624
+ /** V1 error format. */
1625
+ '$.xgafv'?: '1' | '2';
1626
+ /** OAuth access token. */
1627
+ access_token?: string;
1628
+ /** Data format for response. */
1629
+ alt?: 'json' | 'media' | 'proto';
1630
+ /** JSONP */
1631
+ callback?: string;
1632
+ /** Selector specifying which fields to include in a partial response. */
1633
+ fields?: string;
1634
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1635
+ key?: string;
1636
+ /** OAuth 2.0 token for the current user. */
1637
+ oauth_token?: string;
1638
+ /** Required. The parent database to list change streams from. Format is `projects/{project}/databases/{database}`. */
1639
+ parent: string;
1640
+ /** Returns response with indentations and line breaks. */
1641
+ prettyPrint?: boolean;
1642
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1643
+ quotaUser?: string;
1644
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1645
+ upload_protocol?: string;
1646
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1647
+ uploadType?: string;
1648
+ }): Request<GoogleFirestoreAdminV1ListChangeStreamsResponse>;
1649
+ }
1461
1650
  interface FieldsResource {
1462
1651
  /** Gets the metadata and configuration for a Field. */
1463
1652
  get(request?: {
@@ -3714,6 +3903,7 @@ declare namespace gapi.client {
3714
3903
  body: GoogleFirestoreAdminV1RestoreDatabaseRequest,
3715
3904
  ): Request<GoogleLongrunningOperation>;
3716
3905
  backupSchedules: BackupSchedulesResource;
3906
+ changeStreams: ChangeStreamsResource;
3717
3907
  collectionGroups: CollectionGroupsResource;
3718
3908
  documents: DocumentsResource;
3719
3909
  operations: OperationsResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.firestore-v1",
3
- "version": "0.3.20260702",
3
+ "version": "0.3.20260810",
4
4
  "description": "TypeScript typings for Cloud Firestore API v1",
5
5
  "repository": {
6
6
  "type": "git",