@maxim_mazurok/gapi.client.firestore-v1 0.3.20260610 → 0.3.20260702
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +49 -1
- 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:
|
|
12
|
+
// Revision: 20260702
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -55,6 +55,8 @@ declare namespace gapi.client {
|
|
|
55
55
|
newTransaction?: TransactionOptions;
|
|
56
56
|
/** Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
|
|
57
57
|
readTime?: string;
|
|
58
|
+
/** Optional. The request options for this request. */
|
|
59
|
+
requestOptions?: RequestOptions;
|
|
58
60
|
/** Reads documents in a transaction. */
|
|
59
61
|
transaction?: string;
|
|
60
62
|
}
|
|
@@ -71,6 +73,8 @@ declare namespace gapi.client {
|
|
|
71
73
|
interface BatchWriteRequest {
|
|
72
74
|
/** Labels associated with this batch write. */
|
|
73
75
|
labels?: {[P in string]: string};
|
|
76
|
+
/** Optional. The request options for this request. */
|
|
77
|
+
requestOptions?: RequestOptions;
|
|
74
78
|
/** The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request. */
|
|
75
79
|
writes?: Write[];
|
|
76
80
|
}
|
|
@@ -83,6 +87,8 @@ declare namespace gapi.client {
|
|
|
83
87
|
interface BeginTransactionRequest {
|
|
84
88
|
/** The options for the transaction. Defaults to a read-write transaction. */
|
|
85
89
|
options?: TransactionOptions;
|
|
90
|
+
/** Optional. The request options for this request. */
|
|
91
|
+
requestOptions?: RequestOptions;
|
|
86
92
|
}
|
|
87
93
|
interface BeginTransactionResponse {
|
|
88
94
|
/** The transaction that was started. */
|
|
@@ -107,6 +113,8 @@ declare namespace gapi.client {
|
|
|
107
113
|
collectionId?: string;
|
|
108
114
|
}
|
|
109
115
|
interface CommitRequest {
|
|
116
|
+
/** Optional. The request options for this request. */
|
|
117
|
+
requestOptions?: RequestOptions;
|
|
110
118
|
/** If set, applies all writes in this transaction, and commits it. */
|
|
111
119
|
transaction?: string;
|
|
112
120
|
/** The writes to apply. Always executed atomically and in order. */
|
|
@@ -190,6 +198,8 @@ declare namespace gapi.client {
|
|
|
190
198
|
newTransaction?: TransactionOptions;
|
|
191
199
|
/** Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
|
|
192
200
|
readTime?: string;
|
|
201
|
+
/** Optional. The request options for this request. */
|
|
202
|
+
requestOptions?: RequestOptions;
|
|
193
203
|
/** A pipelined operation. */
|
|
194
204
|
structuredPipeline?: StructuredPipeline;
|
|
195
205
|
/** Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in. */
|
|
@@ -892,6 +902,8 @@ declare namespace gapi.client {
|
|
|
892
902
|
pageToken?: string;
|
|
893
903
|
/** Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
|
|
894
904
|
readTime?: string;
|
|
905
|
+
/** Optional. The request options for this request. */
|
|
906
|
+
requestOptions?: RequestOptions;
|
|
895
907
|
}
|
|
896
908
|
interface ListCollectionIdsResponse {
|
|
897
909
|
/** The collection ids. */
|
|
@@ -912,6 +924,8 @@ declare namespace gapi.client {
|
|
|
912
924
|
labels?: {[P in string]: string};
|
|
913
925
|
/** The ID of a target to remove from this stream. */
|
|
914
926
|
removeTarget?: number;
|
|
927
|
+
/** Optional. The request options for the request. */
|
|
928
|
+
requestOptions?: RequestOptions;
|
|
915
929
|
}
|
|
916
930
|
interface ListenResponse {
|
|
917
931
|
/** A Document has changed. */
|
|
@@ -962,6 +976,8 @@ declare namespace gapi.client {
|
|
|
962
976
|
partitionCount?: string;
|
|
963
977
|
/** Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
|
|
964
978
|
readTime?: string;
|
|
979
|
+
/** Optional. The request options for the request. */
|
|
980
|
+
requestOptions?: RequestOptions;
|
|
965
981
|
/** A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported. */
|
|
966
982
|
structuredQuery?: StructuredQuery;
|
|
967
983
|
}
|
|
@@ -1006,7 +1022,13 @@ declare namespace gapi.client {
|
|
|
1006
1022
|
/** An optional transaction to retry. */
|
|
1007
1023
|
retryTransaction?: string;
|
|
1008
1024
|
}
|
|
1025
|
+
interface RequestOptions {
|
|
1026
|
+
/** Optional. The request tags for the request. */
|
|
1027
|
+
requestTags?: string[];
|
|
1028
|
+
}
|
|
1009
1029
|
interface RollbackRequest {
|
|
1030
|
+
/** Optional. The request options for this request. */
|
|
1031
|
+
requestOptions?: RequestOptions;
|
|
1010
1032
|
/** Required. The transaction to roll back. */
|
|
1011
1033
|
transaction?: string;
|
|
1012
1034
|
}
|
|
@@ -1017,6 +1039,8 @@ declare namespace gapi.client {
|
|
|
1017
1039
|
newTransaction?: TransactionOptions;
|
|
1018
1040
|
/** Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
|
|
1019
1041
|
readTime?: string;
|
|
1042
|
+
/** Optional. The request options for the request. */
|
|
1043
|
+
requestOptions?: RequestOptions;
|
|
1020
1044
|
/** An aggregation query. */
|
|
1021
1045
|
structuredAggregationQuery?: StructuredAggregationQuery;
|
|
1022
1046
|
/** Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in. */
|
|
@@ -1039,6 +1063,8 @@ declare namespace gapi.client {
|
|
|
1039
1063
|
newTransaction?: TransactionOptions;
|
|
1040
1064
|
/** Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
|
|
1041
1065
|
readTime?: string;
|
|
1066
|
+
/** Optional. The request options for this request. */
|
|
1067
|
+
requestOptions?: RequestOptions;
|
|
1042
1068
|
/** A structured query. */
|
|
1043
1069
|
structuredQuery?: StructuredQuery;
|
|
1044
1070
|
/** Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in. */
|
|
@@ -1204,6 +1230,8 @@ declare namespace gapi.client {
|
|
|
1204
1230
|
interface WriteRequest {
|
|
1205
1231
|
/** Labels associated with this write request. */
|
|
1206
1232
|
labels?: {[P in string]: string};
|
|
1233
|
+
/** Optional. The request options for the request. */
|
|
1234
|
+
requestOptions?: RequestOptions;
|
|
1207
1235
|
/** The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. */
|
|
1208
1236
|
streamId?: string;
|
|
1209
1237
|
/** A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream. */
|
|
@@ -1966,6 +1994,8 @@ declare namespace gapi.client {
|
|
|
1966
1994
|
prettyPrint?: boolean;
|
|
1967
1995
|
/** 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. */
|
|
1968
1996
|
quotaUser?: string;
|
|
1997
|
+
/** Optional. The request tags for the request. */
|
|
1998
|
+
'requestOptions.requestTags'?: string | string[];
|
|
1969
1999
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1970
2000
|
upload_protocol?: string;
|
|
1971
2001
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -2001,6 +2031,8 @@ declare namespace gapi.client {
|
|
|
2001
2031
|
prettyPrint?: boolean;
|
|
2002
2032
|
/** 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. */
|
|
2003
2033
|
quotaUser?: string;
|
|
2034
|
+
/** Optional. The request tags for the request. */
|
|
2035
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2004
2036
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2005
2037
|
upload_protocol?: string;
|
|
2006
2038
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -2034,6 +2066,8 @@ declare namespace gapi.client {
|
|
|
2034
2066
|
prettyPrint?: boolean;
|
|
2035
2067
|
/** 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. */
|
|
2036
2068
|
quotaUser?: string;
|
|
2069
|
+
/** Optional. The request tags for the request. */
|
|
2070
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2037
2071
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2038
2072
|
upload_protocol?: string;
|
|
2039
2073
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -2123,6 +2157,8 @@ declare namespace gapi.client {
|
|
|
2123
2157
|
quotaUser?: string;
|
|
2124
2158
|
/** Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
|
|
2125
2159
|
readTime?: string;
|
|
2160
|
+
/** Optional. The request tags for the request. */
|
|
2161
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2126
2162
|
/** Reads the document in a transaction. */
|
|
2127
2163
|
transaction?: string;
|
|
2128
2164
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
@@ -2164,6 +2200,10 @@ declare namespace gapi.client {
|
|
|
2164
2200
|
quotaUser?: string;
|
|
2165
2201
|
/** Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
|
|
2166
2202
|
readTime?: string;
|
|
2203
|
+
/** Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. */
|
|
2204
|
+
recursive?: boolean;
|
|
2205
|
+
/** Optional. The request tags for the request. */
|
|
2206
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2167
2207
|
/** If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. */
|
|
2168
2208
|
showMissing?: boolean;
|
|
2169
2209
|
/** Perform the read as part of an already active transaction. */
|
|
@@ -2265,6 +2305,10 @@ declare namespace gapi.client {
|
|
|
2265
2305
|
quotaUser?: string;
|
|
2266
2306
|
/** Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
|
|
2267
2307
|
readTime?: string;
|
|
2308
|
+
/** Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. */
|
|
2309
|
+
recursive?: boolean;
|
|
2310
|
+
/** Optional. The request tags for the request. */
|
|
2311
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2268
2312
|
/** If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. */
|
|
2269
2313
|
showMissing?: boolean;
|
|
2270
2314
|
/** Perform the read as part of an already active transaction. */
|
|
@@ -2418,6 +2462,8 @@ declare namespace gapi.client {
|
|
|
2418
2462
|
prettyPrint?: boolean;
|
|
2419
2463
|
/** 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. */
|
|
2420
2464
|
quotaUser?: string;
|
|
2465
|
+
/** Optional. The request tags for the request. */
|
|
2466
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2421
2467
|
/** The list of field paths in the mask. See Document.fields for a field path syntax reference. */
|
|
2422
2468
|
'updateMask.fieldPaths'?: string | string[];
|
|
2423
2469
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
@@ -2455,6 +2501,8 @@ declare namespace gapi.client {
|
|
|
2455
2501
|
prettyPrint?: boolean;
|
|
2456
2502
|
/** 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. */
|
|
2457
2503
|
quotaUser?: string;
|
|
2504
|
+
/** Optional. The request tags for the request. */
|
|
2505
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2458
2506
|
/** The list of field paths in the mask. See Document.fields for a field path syntax reference. */
|
|
2459
2507
|
'updateMask.fieldPaths'?: string | string[];
|
|
2460
2508
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|