@maxim_mazurok/gapi.client.firebase-v1beta1 0.0.20220811
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 +2264 -0
- package/package.json +20 -0
- package/readme.md +132 -0
- package/tests.ts +392 -0
- package/tsconfig.json +18 -0
- package/tslint.json +6 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,2264 @@
|
|
|
1
|
+
/* Type definitions for non-npm package Firebase Management API v1beta1 0.0 */
|
|
2
|
+
// Project: https://firebase.google.com
|
|
3
|
+
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
|
+
// Nick Amoscato <https://github.com/namoscato>
|
|
5
|
+
// Declan Vong <https://github.com/declanvong>
|
|
6
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
7
|
+
// TypeScript Version: 2.8
|
|
8
|
+
|
|
9
|
+
// IMPORTANT
|
|
10
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
11
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
12
|
+
// Generated from: https://firebase.googleapis.com/$discovery/rest?version=v1beta1
|
|
13
|
+
// Revision: 20220811
|
|
14
|
+
|
|
15
|
+
/// <reference types="gapi.client" />
|
|
16
|
+
|
|
17
|
+
declare namespace gapi.client {
|
|
18
|
+
/** Load Firebase Management API v1beta1 */
|
|
19
|
+
function load(urlOrObject: "https://firebase.googleapis.com/$discovery/rest?version=v1beta1"): Promise<void>;
|
|
20
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
21
|
+
function load(name: "firebase", version: "v1beta1"): Promise<void>;
|
|
22
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
23
|
+
function load(name: "firebase", version: "v1beta1", callback: () => any): void;
|
|
24
|
+
|
|
25
|
+
namespace firebase {
|
|
26
|
+
interface AddFirebaseRequest {
|
|
27
|
+
/**
|
|
28
|
+
* Deprecated. Instead, to set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the
|
|
29
|
+
* GCP `Project`. The ID of the Project's default GCP resource location. The location must be one of the available [GCP resource
|
|
30
|
+
* locations](https://firebase.google.com/docs/projects/locations).
|
|
31
|
+
*/
|
|
32
|
+
locationId?: string;
|
|
33
|
+
}
|
|
34
|
+
interface AddGoogleAnalyticsRequest {
|
|
35
|
+
/**
|
|
36
|
+
* The ID for the existing [Google Analytics account](http://www.google.com/analytics/) that you want to link with the `FirebaseProject`. Specifying this field will provision a new
|
|
37
|
+
* Google Analytics property in your Google Analytics account and associate the new property with the `FirebaseProject`.
|
|
38
|
+
*/
|
|
39
|
+
analyticsAccountId?: string;
|
|
40
|
+
/** The ID for the existing Google Analytics property that you want to associate with the `FirebaseProject`. */
|
|
41
|
+
analyticsPropertyId?: string;
|
|
42
|
+
}
|
|
43
|
+
interface AdminSdkConfig {
|
|
44
|
+
/** The default Firebase Realtime Database URL. */
|
|
45
|
+
databaseURL?: string;
|
|
46
|
+
/**
|
|
47
|
+
* The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field
|
|
48
|
+
* is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call
|
|
49
|
+
* [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
|
|
50
|
+
*/
|
|
51
|
+
locationId?: string;
|
|
52
|
+
/**
|
|
53
|
+
* Immutable. A user-assigned unique identifier for the `FirebaseProject`. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it
|
|
54
|
+
* should generally be treated as a convenience alias to reference the Project.
|
|
55
|
+
*/
|
|
56
|
+
projectId?: string;
|
|
57
|
+
/** The default Cloud Storage for Firebase storage bucket name. */
|
|
58
|
+
storageBucket?: string;
|
|
59
|
+
}
|
|
60
|
+
interface AnalyticsDetails {
|
|
61
|
+
/** The Analytics Property object associated with the specified `FirebaseProject`. This object contains the details of the Google Analytics property associated with the Project. */
|
|
62
|
+
analyticsProperty?: AnalyticsProperty;
|
|
63
|
+
/**
|
|
64
|
+
* - For `AndroidApps` and `IosApps`: a map of `app` to `streamId` for each Firebase App in the specified `FirebaseProject`. Each `app` and `streamId` appears only once. - For
|
|
65
|
+
* `WebApps`: a map of `app` to `streamId` and `measurementId` for each `WebApp` in the specified `FirebaseProject`. Each `app`, `streamId`, and `measurementId` appears only once.
|
|
66
|
+
*/
|
|
67
|
+
streamMappings?: StreamMapping[];
|
|
68
|
+
}
|
|
69
|
+
interface AnalyticsProperty {
|
|
70
|
+
/** Output only. The ID of the [Google Analytics account](https://www.google.com/analytics/) for the Google Analytics property associated with the specified FirebaseProject. */
|
|
71
|
+
analyticsAccountId?: string;
|
|
72
|
+
/** The display name of the Google Analytics property associated with the specified `FirebaseProject`. */
|
|
73
|
+
displayName?: string;
|
|
74
|
+
/**
|
|
75
|
+
* The globally unique, Google-assigned identifier of the Google Analytics property associated with the specified `FirebaseProject`. If you called
|
|
76
|
+
* [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) to link the `FirebaseProject` with a Google Analytics account, the value in this `id` field is the same as the ID
|
|
77
|
+
* of the property either specified or provisioned with that call to `AddGoogleAnalytics`.
|
|
78
|
+
*/
|
|
79
|
+
id?: string;
|
|
80
|
+
}
|
|
81
|
+
interface AndroidApp {
|
|
82
|
+
/**
|
|
83
|
+
* The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `AndroidApp`. Be aware that this value is the UID of the API key, _not_ the
|
|
84
|
+
* [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found
|
|
85
|
+
* in the App's [configuration artifact](../../rest/v1beta1/projects.androidApps/getConfig). If `api_key_id` is not set in requests to
|
|
86
|
+
* [`androidApps.Create`](../../rest/v1beta1/projects.androidApps/create), then Firebase automatically associates an `api_key_id` with the `AndroidApp`. This auto-associated key may be
|
|
87
|
+
* an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, `api_key_id` cannot be set to an empty value, and the new UID must have no
|
|
88
|
+
* restrictions or only have restrictions that are valid for the associated `AndroidApp`. We recommend using the [Google Cloud
|
|
89
|
+
* Console](https://console.cloud.google.com/apis/credentials) to manage API keys.
|
|
90
|
+
*/
|
|
91
|
+
apiKeyId?: string;
|
|
92
|
+
/**
|
|
93
|
+
* Output only. Immutable. The globally unique, Firebase-assigned identifier for the `AndroidApp`. This identifier should be treated as an opaque token, as the data format is not
|
|
94
|
+
* specified.
|
|
95
|
+
*/
|
|
96
|
+
appId?: string;
|
|
97
|
+
/** The user-assigned display name for the `AndroidApp`. */
|
|
98
|
+
displayName?: string;
|
|
99
|
+
/**
|
|
100
|
+
* The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's
|
|
101
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using
|
|
102
|
+
* project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
|
|
103
|
+
* APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)).
|
|
104
|
+
*/
|
|
105
|
+
name?: string;
|
|
106
|
+
/** Immutable. The canonical package name of the Android app as would appear in the Google Play Developer Console. */
|
|
107
|
+
packageName?: string;
|
|
108
|
+
/** Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `AndroidApp`. */
|
|
109
|
+
projectId?: string;
|
|
110
|
+
/** The SHA1 certificate hashes for the AndroidApp. */
|
|
111
|
+
sha1Hashes?: string[];
|
|
112
|
+
/** The SHA256 certificate hashes for the AndroidApp. */
|
|
113
|
+
sha256Hashes?: string[];
|
|
114
|
+
/** Output only. The lifecycle state of the App. */
|
|
115
|
+
state?: string;
|
|
116
|
+
}
|
|
117
|
+
interface AndroidAppConfig {
|
|
118
|
+
/** The contents of the JSON configuration file. */
|
|
119
|
+
configFileContents?: string;
|
|
120
|
+
/** The filename that the configuration artifact for the `AndroidApp` is typically saved as. For example: `google-services.json` */
|
|
121
|
+
configFilename?: string;
|
|
122
|
+
}
|
|
123
|
+
interface DefaultResources {
|
|
124
|
+
/**
|
|
125
|
+
* Output only. The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Hosting site in
|
|
126
|
+
* another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a
|
|
127
|
+
* hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be:
|
|
128
|
+
* `myproject123-a5c16`
|
|
129
|
+
*/
|
|
130
|
+
hostingSite?: string;
|
|
131
|
+
/**
|
|
132
|
+
* Output only. The ID of the Project's default GCP resource location. The location is one of the available [GCP resource
|
|
133
|
+
* locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default
|
|
134
|
+
* GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
|
|
135
|
+
*/
|
|
136
|
+
locationId?: string;
|
|
137
|
+
/**
|
|
138
|
+
* Output only. The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Realtime
|
|
139
|
+
* Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended
|
|
140
|
+
* with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database
|
|
141
|
+
* instance name might be: `myproject123-a5c16`
|
|
142
|
+
*/
|
|
143
|
+
realtimeDatabaseInstance?: string;
|
|
144
|
+
/** Output only. The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com */
|
|
145
|
+
storageBucket?: string;
|
|
146
|
+
}
|
|
147
|
+
// tslint:disable-next-line:no-empty-interface
|
|
148
|
+
interface Empty {
|
|
149
|
+
}
|
|
150
|
+
interface FinalizeDefaultLocationRequest {
|
|
151
|
+
/** The ID of the Project's default GCP resource location. The location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). */
|
|
152
|
+
locationId?: string;
|
|
153
|
+
}
|
|
154
|
+
interface FirebaseAppInfo {
|
|
155
|
+
/**
|
|
156
|
+
* The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the App. Be aware that this value is the UID of the API key, _not_ the
|
|
157
|
+
* [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found
|
|
158
|
+
* in the App's configuration artifact ([`AndroidApp`](../../rest/v1beta1/projects.androidApps/getConfig) | [`IosApp`](../../rest/v1beta1/projects.iosApps/getConfig) |
|
|
159
|
+
* [`WebApp`](../../rest/v1beta1/projects.webApps/getConfig)). If `api_key_id` is not set in requests to create the App ([`AndroidApp`](../../rest/v1beta1/projects.androidApps/create)
|
|
160
|
+
* | [`IosApp`](../../rest/v1beta1/projects.iosApps/create) | [`WebApp`](../../rest/v1beta1/projects.webApps/create)), then Firebase automatically associates an `api_key_id` with the
|
|
161
|
+
* App. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned.
|
|
162
|
+
*/
|
|
163
|
+
apiKeyId?: string;
|
|
164
|
+
/**
|
|
165
|
+
* Output only. Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. This identifier should be treated as an opaque token, as the data format is not
|
|
166
|
+
* specified.
|
|
167
|
+
*/
|
|
168
|
+
appId?: string;
|
|
169
|
+
/** The user-assigned display name of the Firebase App. */
|
|
170
|
+
displayName?: string;
|
|
171
|
+
/** The resource name of the Firebase App, in the format: projects/PROJECT_ID /iosApps/APP_ID or projects/PROJECT_ID/androidApps/APP_ID or projects/ PROJECT_ID/webApps/APP_ID */
|
|
172
|
+
name?: string;
|
|
173
|
+
/**
|
|
174
|
+
* Output only. Immutable. The platform-specific identifier of the App. *Note:* For most use cases, use `appId`, which is the canonical, globally unique identifier for referencing an
|
|
175
|
+
* App. This string is derived from a native identifier for each platform: `packageName` for an `AndroidApp`, `bundleId` for an `IosApp`, and `webId` for a `WebApp`. Its contents
|
|
176
|
+
* should be treated as opaque, as the native identifier format may change as platforms evolve. This string is only unique within a `FirebaseProject` and its associated Apps.
|
|
177
|
+
*/
|
|
178
|
+
namespace?: string;
|
|
179
|
+
/** The platform of the Firebase App. */
|
|
180
|
+
platform?: string;
|
|
181
|
+
/** Output only. The lifecycle state of the App. */
|
|
182
|
+
state?: string;
|
|
183
|
+
}
|
|
184
|
+
interface FirebaseProject {
|
|
185
|
+
/**
|
|
186
|
+
* Set of user-defined annotations for the FirebaseProject as per [AIP-128](https://google.aip.dev/128#annotations). These annotations are intended solely for developers and
|
|
187
|
+
* client-side tools Firebase services will not mutate this annotation set.
|
|
188
|
+
*/
|
|
189
|
+
annotations?: { [P in string]: string };
|
|
190
|
+
/** The user-assigned display name of the Project. */
|
|
191
|
+
displayName?: string;
|
|
192
|
+
/**
|
|
193
|
+
* This checksum is computed by the server based on the value of other fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
|
|
194
|
+
* [AIP-154](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated.
|
|
195
|
+
*/
|
|
196
|
+
etag?: string;
|
|
197
|
+
/**
|
|
198
|
+
* The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
|
|
199
|
+
* ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510
|
|
200
|
+
* standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`.
|
|
201
|
+
*/
|
|
202
|
+
name?: string;
|
|
203
|
+
/**
|
|
204
|
+
* Output only. A user-assigned unique identifier for the Project. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should
|
|
205
|
+
* generally be treated as a convenience alias to reference the Project.
|
|
206
|
+
*/
|
|
207
|
+
projectId?: string;
|
|
208
|
+
/**
|
|
209
|
+
* Output only. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Firebase or
|
|
210
|
+
* third-party services.
|
|
211
|
+
*/
|
|
212
|
+
projectNumber?: string;
|
|
213
|
+
/** Output only. The default Firebase resources associated with the Project. */
|
|
214
|
+
resources?: DefaultResources;
|
|
215
|
+
/**
|
|
216
|
+
* Output only. The lifecycle state of the Project. Updates to the state must be performed via com.google.cloudresourcemanager.v1.Projects.DeleteProject and
|
|
217
|
+
* com.google.cloudresourcemanager.v1.Projects.UndeleteProject
|
|
218
|
+
*/
|
|
219
|
+
state?: string;
|
|
220
|
+
}
|
|
221
|
+
interface IosApp {
|
|
222
|
+
/**
|
|
223
|
+
* The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `IosApp`. Be aware that this value is the UID of the API key, _not_ the
|
|
224
|
+
* [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found
|
|
225
|
+
* in the App's [configuration artifact](../../rest/v1beta1/projects.iosApps/getConfig). If `api_key_id` is not set in requests to
|
|
226
|
+
* [`iosApps.Create`](../../rest/v1beta1/projects.iosApps/create), then Firebase automatically associates an `api_key_id` with the `IosApp`. This auto-associated key may be an existing
|
|
227
|
+
* valid key or, if no valid key exists, a new one will be provisioned. In patch requests, `api_key_id` cannot be set to an empty value, and the new UID must have no restrictions or
|
|
228
|
+
* only have restrictions that are valid for the associated `IosApp`. We recommend using the [Google Cloud Console](https://console.cloud.google.com/apis/credentials) to manage API
|
|
229
|
+
* keys.
|
|
230
|
+
*/
|
|
231
|
+
apiKeyId?: string;
|
|
232
|
+
/**
|
|
233
|
+
* Output only. Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. This identifier should be treated as an opaque token, as the data format is not
|
|
234
|
+
* specified.
|
|
235
|
+
*/
|
|
236
|
+
appId?: string;
|
|
237
|
+
/** The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store. */
|
|
238
|
+
appStoreId?: string;
|
|
239
|
+
/** Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore. */
|
|
240
|
+
bundleId?: string;
|
|
241
|
+
/** The user-assigned display name for the `IosApp`. */
|
|
242
|
+
displayName?: string;
|
|
243
|
+
/**
|
|
244
|
+
* The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's
|
|
245
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using
|
|
246
|
+
* project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
|
|
247
|
+
* APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
|
|
248
|
+
*/
|
|
249
|
+
name?: string;
|
|
250
|
+
/** Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`. */
|
|
251
|
+
projectId?: string;
|
|
252
|
+
/** Output only. The lifecycle state of the App. */
|
|
253
|
+
state?: string;
|
|
254
|
+
/** The Apple Developer Team ID associated with the App in the App Store. */
|
|
255
|
+
teamId?: string;
|
|
256
|
+
}
|
|
257
|
+
interface IosAppConfig {
|
|
258
|
+
/** The content of the XML configuration file. */
|
|
259
|
+
configFileContents?: string;
|
|
260
|
+
/** The filename that the configuration artifact for the `IosApp` is typically saved as. For example: `GoogleService-Info.plist` */
|
|
261
|
+
configFilename?: string;
|
|
262
|
+
}
|
|
263
|
+
interface ListAndroidAppsResponse {
|
|
264
|
+
/** List of each `AndroidApp` associated with the specified `FirebaseProject`. */
|
|
265
|
+
apps?: AndroidApp[];
|
|
266
|
+
/**
|
|
267
|
+
* If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used
|
|
268
|
+
* in a subsequent call to `ListAndroidApps` to find the next group of Apps. Page tokens are short-lived and should not be persisted.
|
|
269
|
+
*/
|
|
270
|
+
nextPageToken?: string;
|
|
271
|
+
}
|
|
272
|
+
interface ListAvailableLocationsResponse {
|
|
273
|
+
/** One page of results from a call to `ListAvailableLocations`. */
|
|
274
|
+
locations?: Location[];
|
|
275
|
+
/**
|
|
276
|
+
* If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results and all available
|
|
277
|
+
* locations have been listed. This token can be used in a subsequent call to `ListAvailableLocations` to find more locations. Page tokens are short-lived and should not be persisted.
|
|
278
|
+
*/
|
|
279
|
+
nextPageToken?: string;
|
|
280
|
+
}
|
|
281
|
+
interface ListAvailableProjectsResponse {
|
|
282
|
+
/**
|
|
283
|
+
* If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used
|
|
284
|
+
* in a subsequent calls to `ListAvailableProjects` to find the next group of Projects. Page tokens are short-lived and should not be persisted.
|
|
285
|
+
*/
|
|
286
|
+
nextPageToken?: string;
|
|
287
|
+
/** The list of GCP `Projects` which can have Firebase resources added to them. */
|
|
288
|
+
projectInfo?: ProjectInfo[];
|
|
289
|
+
}
|
|
290
|
+
interface ListFirebaseProjectsResponse {
|
|
291
|
+
/**
|
|
292
|
+
* If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used
|
|
293
|
+
* in a subsequent calls to `ListFirebaseProjects` to find the next group of Projects. Page tokens are short-lived and should not be persisted.
|
|
294
|
+
*/
|
|
295
|
+
nextPageToken?: string;
|
|
296
|
+
/** One page of the list of Projects that are accessible to the caller. */
|
|
297
|
+
results?: FirebaseProject[];
|
|
298
|
+
}
|
|
299
|
+
interface ListIosAppsResponse {
|
|
300
|
+
/** List of each `IosApp` associated with the specified `FirebaseProject`. */
|
|
301
|
+
apps?: IosApp[];
|
|
302
|
+
/**
|
|
303
|
+
* If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used
|
|
304
|
+
* in a subsequent call to `ListIosApps` to find the next group of Apps. Page tokens are short-lived and should not be persisted.
|
|
305
|
+
*/
|
|
306
|
+
nextPageToken?: string;
|
|
307
|
+
}
|
|
308
|
+
interface ListShaCertificatesResponse {
|
|
309
|
+
/** The list of each `ShaCertificate` associated with the `AndroidApp`. */
|
|
310
|
+
certificates?: ShaCertificate[];
|
|
311
|
+
}
|
|
312
|
+
interface ListWebAppsResponse {
|
|
313
|
+
/** List of each `WebApp` associated with the specified `FirebaseProject`. */
|
|
314
|
+
apps?: WebApp[];
|
|
315
|
+
/**
|
|
316
|
+
* If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used
|
|
317
|
+
* in a subsequent call to `ListWebApps` to find the next group of Apps. Page tokens are short-lived and should not be persisted.
|
|
318
|
+
*/
|
|
319
|
+
nextPageToken?: string;
|
|
320
|
+
}
|
|
321
|
+
interface Location {
|
|
322
|
+
/** Products and services that are available in the GCP resource location. */
|
|
323
|
+
features?: string[];
|
|
324
|
+
/** The ID of the GCP resource location. It will be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations#types). */
|
|
325
|
+
locationId?: string;
|
|
326
|
+
/** Indicates whether the GCP resource location is a [regional or multi-regional location](https://firebase.google.com/docs/projects/locations#types) for data replication. */
|
|
327
|
+
type?: string;
|
|
328
|
+
}
|
|
329
|
+
// tslint:disable-next-line:no-empty-interface
|
|
330
|
+
interface MessageSet {
|
|
331
|
+
}
|
|
332
|
+
interface Operation {
|
|
333
|
+
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
334
|
+
done?: boolean;
|
|
335
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
336
|
+
error?: Status;
|
|
337
|
+
/**
|
|
338
|
+
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
|
|
339
|
+
* metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
|
340
|
+
*/
|
|
341
|
+
metadata?: { [P in string]: any };
|
|
342
|
+
/**
|
|
343
|
+
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
|
|
344
|
+
* with `operations/{unique_id}`.
|
|
345
|
+
*/
|
|
346
|
+
name?: string;
|
|
347
|
+
/**
|
|
348
|
+
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
|
|
349
|
+
* original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the
|
|
350
|
+
* original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
|
351
|
+
*/
|
|
352
|
+
response?: { [P in string]: any };
|
|
353
|
+
}
|
|
354
|
+
interface ProjectInfo {
|
|
355
|
+
/** The user-assigned display name of the GCP `Project`, for example: `My App` */
|
|
356
|
+
displayName?: string;
|
|
357
|
+
/**
|
|
358
|
+
* The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). Not all
|
|
359
|
+
* Projects will have this field populated. If it is not populated, it means that the Project does not yet have a default GCP resource location. To set a Project's default GCP resource
|
|
360
|
+
* location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
|
|
361
|
+
*/
|
|
362
|
+
locationId?: string;
|
|
363
|
+
/**
|
|
364
|
+
* The resource name of the GCP `Project` to which Firebase resources can be added, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject`
|
|
365
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
366
|
+
*/
|
|
367
|
+
project?: string;
|
|
368
|
+
}
|
|
369
|
+
interface RemoveAnalyticsRequest {
|
|
370
|
+
/**
|
|
371
|
+
* Optional. The ID of the Google Analytics property associated with the specified `FirebaseProject`. - If not set, then the Google Analytics property that is currently associated with
|
|
372
|
+
* the specified `FirebaseProject` is removed. - If set, and the specified `FirebaseProject` is currently associated with a *different* Google Analytics property, then the response is
|
|
373
|
+
* a `412 Precondition Failed` error.
|
|
374
|
+
*/
|
|
375
|
+
analyticsPropertyId?: string;
|
|
376
|
+
}
|
|
377
|
+
interface RemoveAndroidAppRequest {
|
|
378
|
+
/** If set to true, and the App is not found, the request will succeed but no action will be taken on the server. */
|
|
379
|
+
allowMissing?: boolean;
|
|
380
|
+
/** Checksum provided in the AndroidApp entity, which if provided ensures the client has an up-to-date value before proceeding. */
|
|
381
|
+
etag?: string;
|
|
382
|
+
/** If set to true, only validate the request and do not delete the app. */
|
|
383
|
+
validateOnly?: boolean;
|
|
384
|
+
}
|
|
385
|
+
interface RemoveIosAppRequest {
|
|
386
|
+
/** If set to true, and the App is not found, the request will succeed but no action will be taken on the server. */
|
|
387
|
+
allowMissing?: boolean;
|
|
388
|
+
/** Checksum provided in the IosApp entity, which if provided ensures the client has an up-to-date value before proceeding. */
|
|
389
|
+
etag?: string;
|
|
390
|
+
/** If set to true, only validate the request and do not delete the app. */
|
|
391
|
+
validateOnly?: boolean;
|
|
392
|
+
}
|
|
393
|
+
interface RemoveWebAppRequest {
|
|
394
|
+
/** If set to true, and the App is not found, the request will succeed but no action will be taken on the server. */
|
|
395
|
+
allowMissing?: boolean;
|
|
396
|
+
/** Checksum provided in the WebApp entity, which if provided ensures the client has an up-to-date value before proceeding. */
|
|
397
|
+
etag?: string;
|
|
398
|
+
/** If set to true, only validate the request and do not delete the app. */
|
|
399
|
+
validateOnly?: boolean;
|
|
400
|
+
}
|
|
401
|
+
interface SearchFirebaseAppsResponse {
|
|
402
|
+
/** One page of results from a call to `SearchFirebaseApps`. */
|
|
403
|
+
apps?: FirebaseAppInfo[];
|
|
404
|
+
/**
|
|
405
|
+
* If the result list is too large to fit in a single response, then a token is returned. This token can be used in a subsequent calls to `SearchFirebaseApps` to find the next group of
|
|
406
|
+
* Apps. Page tokens are short-lived and should not be persisted.
|
|
407
|
+
*/
|
|
408
|
+
nextPageToken?: string;
|
|
409
|
+
}
|
|
410
|
+
interface ShaCertificate {
|
|
411
|
+
/** The type of SHA certificate encoded in the hash. */
|
|
412
|
+
certType?: string;
|
|
413
|
+
/**
|
|
414
|
+
* The resource name of the ShaCertificate for the AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID/sha/SHA_HASH * PROJECT_IDENTIFIER: the parent Project's
|
|
415
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using
|
|
416
|
+
* project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
|
|
417
|
+
* APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)). * SHA_HASH: the certificate hash for the App
|
|
418
|
+
* (see [`shaHash`](../projects.androidApps.sha#ShaCertificate.FIELDS.sha_hash)).
|
|
419
|
+
*/
|
|
420
|
+
name?: string;
|
|
421
|
+
/** The certificate hash for the `AndroidApp`. */
|
|
422
|
+
shaHash?: string;
|
|
423
|
+
}
|
|
424
|
+
interface Status {
|
|
425
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
426
|
+
code?: number;
|
|
427
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
428
|
+
details?: Array<{ [P in string]: any }>;
|
|
429
|
+
/**
|
|
430
|
+
* 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
|
|
431
|
+
* client.
|
|
432
|
+
*/
|
|
433
|
+
message?: string;
|
|
434
|
+
}
|
|
435
|
+
interface StatusProto {
|
|
436
|
+
/** The canonical error code (see codes.proto) that most closely corresponds to this status. May be missing. */
|
|
437
|
+
canonicalCode?: number;
|
|
438
|
+
/** Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto */
|
|
439
|
+
code?: number;
|
|
440
|
+
/** Detail message */
|
|
441
|
+
message?: string;
|
|
442
|
+
/** message_set associates an arbitrary proto message with the status. */
|
|
443
|
+
messageSet?: any;
|
|
444
|
+
/** The following are usually only present when code != 0 Space to which this status belongs */
|
|
445
|
+
space?: string;
|
|
446
|
+
}
|
|
447
|
+
interface StreamMapping {
|
|
448
|
+
/**
|
|
449
|
+
* The resource name of the Firebase App associated with the Google Analytics data stream, in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID or
|
|
450
|
+
* projects/PROJECT_IDENTIFIER/iosApps/APP_ID or projects/PROJECT_IDENTIFIER /webApps/APP_ID Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for
|
|
451
|
+
* details about PROJECT_IDENTIFIER values.
|
|
452
|
+
*/
|
|
453
|
+
app?: string;
|
|
454
|
+
/**
|
|
455
|
+
* Applicable for Firebase Web Apps only. The unique Google-assigned identifier of the Google Analytics web stream associated with the Firebase Web App. Firebase SDKs use this ID to
|
|
456
|
+
* interact with Google Analytics APIs. Learn more about this ID and Google Analytics web streams in the [Analytics documentation](https://support.google.com/analytics/answer/9304153).
|
|
457
|
+
*/
|
|
458
|
+
measurementId?: string;
|
|
459
|
+
/**
|
|
460
|
+
* The unique Google-assigned identifier of the Google Analytics data stream associated with the Firebase App. Learn more about Google Analytics data streams in the [Analytics
|
|
461
|
+
* documentation](https://support.google.com/analytics/answer/9303323).
|
|
462
|
+
*/
|
|
463
|
+
streamId?: string;
|
|
464
|
+
}
|
|
465
|
+
interface WebApp {
|
|
466
|
+
/**
|
|
467
|
+
* The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `WebApp`. Be aware that this value is the UID of the API key, _not_ the
|
|
468
|
+
* [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found
|
|
469
|
+
* in the App's [configuration artifact](../../rest/v1beta1/projects.webApps/getConfig). If `api_key_id` is not set in requests to
|
|
470
|
+
* [`webApps.Create`](../../rest/v1beta1/projects.webApps/create), then Firebase automatically associates an `api_key_id` with the `WebApp`. This auto-associated key may be an existing
|
|
471
|
+
* valid key or, if no valid key exists, a new one will be provisioned. In patch requests, `api_key_id` cannot be set to an empty value, and the new UID must have no restrictions or
|
|
472
|
+
* only have restrictions that are valid for the associated `WebApp`. We recommend using the [Google Cloud Console](https://console.cloud.google.com/apis/credentials) to manage API
|
|
473
|
+
* keys.
|
|
474
|
+
*/
|
|
475
|
+
apiKeyId?: string;
|
|
476
|
+
/**
|
|
477
|
+
* Output only. Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. This identifier should be treated as an opaque token, as the data format is not
|
|
478
|
+
* specified.
|
|
479
|
+
*/
|
|
480
|
+
appId?: string;
|
|
481
|
+
/** The URLs where the `WebApp` is hosted. */
|
|
482
|
+
appUrls?: string[];
|
|
483
|
+
/** The user-assigned display name for the `WebApp`. */
|
|
484
|
+
displayName?: string;
|
|
485
|
+
/**
|
|
486
|
+
* The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's
|
|
487
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using
|
|
488
|
+
* project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
|
|
489
|
+
* APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
|
|
490
|
+
*/
|
|
491
|
+
name?: string;
|
|
492
|
+
/** Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `WebApp`. */
|
|
493
|
+
projectId?: string;
|
|
494
|
+
/** Output only. The lifecycle state of the App. */
|
|
495
|
+
state?: string;
|
|
496
|
+
/**
|
|
497
|
+
* Output only. Immutable. A unique, Firebase-assigned identifier for the `WebApp`. This identifier is only used to populate the `namespace` value for the `WebApp`. For most use cases,
|
|
498
|
+
* use `appId` to identify or reference the App. The `webId` value is only unique within a `FirebaseProject` and its associated Apps.
|
|
499
|
+
*/
|
|
500
|
+
webId?: string;
|
|
501
|
+
}
|
|
502
|
+
interface WebAppConfig {
|
|
503
|
+
/**
|
|
504
|
+
* The [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key associated with the `WebApp`. Note that this
|
|
505
|
+
* value is _not_ the [`apiKeyId`](../projects.webApps#WebApp.FIELDS.api_key_id) (the UID) of the API key associated with the `WebApp`.
|
|
506
|
+
*/
|
|
507
|
+
apiKey?: string;
|
|
508
|
+
/** Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. */
|
|
509
|
+
appId?: string;
|
|
510
|
+
/** The domain Firebase Auth configures for OAuth redirects, in the format: PROJECT_ID.firebaseapp.com */
|
|
511
|
+
authDomain?: string;
|
|
512
|
+
/** The default Firebase Realtime Database URL. */
|
|
513
|
+
databaseURL?: string;
|
|
514
|
+
/**
|
|
515
|
+
* The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field
|
|
516
|
+
* is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call
|
|
517
|
+
* [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
|
|
518
|
+
*/
|
|
519
|
+
locationId?: string;
|
|
520
|
+
/**
|
|
521
|
+
* The unique Google-assigned identifier of the Google Analytics web stream associated with the `WebApp`. Firebase SDKs use this ID to interact with Google Analytics APIs. This field
|
|
522
|
+
* is only present if the `WebApp` is linked to a web stream in a Google Analytics App + Web property. Learn more about this ID and Google Analytics web streams in the [Analytics
|
|
523
|
+
* documentation](https://support.google.com/analytics/answer/9304153). To generate a `measurementId` and link the `WebApp` with a Google Analytics web stream, call
|
|
524
|
+
* [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics). For apps using the Firebase JavaScript SDK v7.20.0 and later, Firebase dynamically fetches the `measurementId`
|
|
525
|
+
* when your app initializes Analytics. Having this ID in your config object is optional, but it does serve as a fallback in the rare case that the dynamic fetch fails.
|
|
526
|
+
*/
|
|
527
|
+
measurementId?: string;
|
|
528
|
+
/** The sender ID for use with Firebase Cloud Messaging. */
|
|
529
|
+
messagingSenderId?: string;
|
|
530
|
+
/** Immutable. A user-assigned unique identifier for the `FirebaseProject`. */
|
|
531
|
+
projectId?: string;
|
|
532
|
+
/** The default Cloud Storage for Firebase storage bucket name. */
|
|
533
|
+
storageBucket?: string;
|
|
534
|
+
}
|
|
535
|
+
interface AvailableProjectsResource {
|
|
536
|
+
/**
|
|
537
|
+
* Lists each [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects) that can have Firebase resources added to it. A Project
|
|
538
|
+
* will only be listed if: - The caller has sufficient [Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase. - The Project is not already a FirebaseProject. - The
|
|
539
|
+
* Project is not in an Organization which has policies that prevent Firebase resources from being added.
|
|
540
|
+
*/
|
|
541
|
+
list(request?: {
|
|
542
|
+
/** V1 error format. */
|
|
543
|
+
"$.xgafv"?: string;
|
|
544
|
+
/** OAuth access token. */
|
|
545
|
+
access_token?: string;
|
|
546
|
+
/** Data format for response. */
|
|
547
|
+
alt?: string;
|
|
548
|
+
/** JSONP */
|
|
549
|
+
callback?: string;
|
|
550
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
551
|
+
fields?: string;
|
|
552
|
+
/** 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. */
|
|
553
|
+
key?: string;
|
|
554
|
+
/** OAuth 2.0 token for the current user. */
|
|
555
|
+
oauth_token?: string;
|
|
556
|
+
/**
|
|
557
|
+
* The maximum number of Projects to return in the response. The server may return fewer than this value at its discretion. If no value is specified (or too large a value is
|
|
558
|
+
* specified), the server will impose its own limit. This value cannot be negative.
|
|
559
|
+
*/
|
|
560
|
+
pageSize?: number;
|
|
561
|
+
/** Token returned from a previous call to `ListAvailableProjects` indicating where in the set of Projects to resume listing. */
|
|
562
|
+
pageToken?: string;
|
|
563
|
+
/** Returns response with indentations and line breaks. */
|
|
564
|
+
prettyPrint?: boolean;
|
|
565
|
+
/** 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. */
|
|
566
|
+
quotaUser?: string;
|
|
567
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
568
|
+
upload_protocol?: string;
|
|
569
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
570
|
+
uploadType?: string;
|
|
571
|
+
}): Request<ListAvailableProjectsResponse>;
|
|
572
|
+
}
|
|
573
|
+
interface OperationsResource {
|
|
574
|
+
/** 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. */
|
|
575
|
+
get(request?: {
|
|
576
|
+
/** V1 error format. */
|
|
577
|
+
"$.xgafv"?: string;
|
|
578
|
+
/** OAuth access token. */
|
|
579
|
+
access_token?: string;
|
|
580
|
+
/** Data format for response. */
|
|
581
|
+
alt?: string;
|
|
582
|
+
/** JSONP */
|
|
583
|
+
callback?: string;
|
|
584
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
585
|
+
fields?: string;
|
|
586
|
+
/** 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. */
|
|
587
|
+
key?: string;
|
|
588
|
+
/** The name of the operation resource. */
|
|
589
|
+
name: string;
|
|
590
|
+
/** OAuth 2.0 token for the current user. */
|
|
591
|
+
oauth_token?: string;
|
|
592
|
+
/** Returns response with indentations and line breaks. */
|
|
593
|
+
prettyPrint?: boolean;
|
|
594
|
+
/** 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. */
|
|
595
|
+
quotaUser?: string;
|
|
596
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
597
|
+
upload_protocol?: string;
|
|
598
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
599
|
+
uploadType?: string;
|
|
600
|
+
}): Request<Operation>;
|
|
601
|
+
}
|
|
602
|
+
interface ShaResource {
|
|
603
|
+
/** Adds a ShaCertificate to the specified AndroidApp. */
|
|
604
|
+
create(request: {
|
|
605
|
+
/** V1 error format. */
|
|
606
|
+
"$.xgafv"?: string;
|
|
607
|
+
/** OAuth access token. */
|
|
608
|
+
access_token?: string;
|
|
609
|
+
/** Data format for response. */
|
|
610
|
+
alt?: string;
|
|
611
|
+
/** JSONP */
|
|
612
|
+
callback?: string;
|
|
613
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
614
|
+
fields?: string;
|
|
615
|
+
/** 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. */
|
|
616
|
+
key?: string;
|
|
617
|
+
/** OAuth 2.0 token for the current user. */
|
|
618
|
+
oauth_token?: string;
|
|
619
|
+
/**
|
|
620
|
+
* The resource name of the parent AndroidApp to which to add a ShaCertificate, in the format: projects/PROJECT_IDENTIFIER/androidApps/ APP_ID Since an APP_ID is a unique
|
|
621
|
+
* identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/androidApps/APP_ID Refer to the `AndroidApp`
|
|
622
|
+
* [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
623
|
+
*/
|
|
624
|
+
parent: string;
|
|
625
|
+
/** Returns response with indentations and line breaks. */
|
|
626
|
+
prettyPrint?: boolean;
|
|
627
|
+
/** 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. */
|
|
628
|
+
quotaUser?: string;
|
|
629
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
630
|
+
upload_protocol?: string;
|
|
631
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
632
|
+
uploadType?: string;
|
|
633
|
+
/** Request body */
|
|
634
|
+
resource: ShaCertificate;
|
|
635
|
+
}): Request<ShaCertificate>;
|
|
636
|
+
create(request: {
|
|
637
|
+
/** V1 error format. */
|
|
638
|
+
"$.xgafv"?: string;
|
|
639
|
+
/** OAuth access token. */
|
|
640
|
+
access_token?: string;
|
|
641
|
+
/** Data format for response. */
|
|
642
|
+
alt?: string;
|
|
643
|
+
/** JSONP */
|
|
644
|
+
callback?: string;
|
|
645
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
646
|
+
fields?: string;
|
|
647
|
+
/** 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. */
|
|
648
|
+
key?: string;
|
|
649
|
+
/** OAuth 2.0 token for the current user. */
|
|
650
|
+
oauth_token?: string;
|
|
651
|
+
/**
|
|
652
|
+
* The resource name of the parent AndroidApp to which to add a ShaCertificate, in the format: projects/PROJECT_IDENTIFIER/androidApps/ APP_ID Since an APP_ID is a unique
|
|
653
|
+
* identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/androidApps/APP_ID Refer to the `AndroidApp`
|
|
654
|
+
* [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
655
|
+
*/
|
|
656
|
+
parent: string;
|
|
657
|
+
/** Returns response with indentations and line breaks. */
|
|
658
|
+
prettyPrint?: boolean;
|
|
659
|
+
/** 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. */
|
|
660
|
+
quotaUser?: string;
|
|
661
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
662
|
+
upload_protocol?: string;
|
|
663
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
664
|
+
uploadType?: string;
|
|
665
|
+
},
|
|
666
|
+
body: ShaCertificate): Request<ShaCertificate>;
|
|
667
|
+
/** Removes a ShaCertificate from the specified AndroidApp. */
|
|
668
|
+
delete(request?: {
|
|
669
|
+
/** V1 error format. */
|
|
670
|
+
"$.xgafv"?: string;
|
|
671
|
+
/** OAuth access token. */
|
|
672
|
+
access_token?: string;
|
|
673
|
+
/** Data format for response. */
|
|
674
|
+
alt?: string;
|
|
675
|
+
/** JSONP */
|
|
676
|
+
callback?: string;
|
|
677
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
678
|
+
fields?: string;
|
|
679
|
+
/** 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. */
|
|
680
|
+
key?: string;
|
|
681
|
+
/**
|
|
682
|
+
* The resource name of the ShaCertificate to remove from the parent AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID /sha/SHA_HASH Refer to the
|
|
683
|
+
* `ShaCertificate` [`name`](../projects.androidApps.sha#ShaCertificate.FIELDS.name) field for details about PROJECT_IDENTIFIER, APP_ID, and SHA_HASH values. You can obtain the
|
|
684
|
+
* full resource name of the `ShaCertificate` from the response of [`ListShaCertificates`](../projects.androidApps.sha/list) or the original
|
|
685
|
+
* [`CreateShaCertificate`](../projects.androidApps.sha/create).
|
|
686
|
+
*/
|
|
687
|
+
name: string;
|
|
688
|
+
/** OAuth 2.0 token for the current user. */
|
|
689
|
+
oauth_token?: string;
|
|
690
|
+
/** Returns response with indentations and line breaks. */
|
|
691
|
+
prettyPrint?: boolean;
|
|
692
|
+
/** 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. */
|
|
693
|
+
quotaUser?: string;
|
|
694
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
695
|
+
upload_protocol?: string;
|
|
696
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
697
|
+
uploadType?: string;
|
|
698
|
+
}): Request<{}>;
|
|
699
|
+
/** Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp. */
|
|
700
|
+
list(request?: {
|
|
701
|
+
/** V1 error format. */
|
|
702
|
+
"$.xgafv"?: string;
|
|
703
|
+
/** OAuth access token. */
|
|
704
|
+
access_token?: string;
|
|
705
|
+
/** Data format for response. */
|
|
706
|
+
alt?: string;
|
|
707
|
+
/** JSONP */
|
|
708
|
+
callback?: string;
|
|
709
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
710
|
+
fields?: string;
|
|
711
|
+
/** 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. */
|
|
712
|
+
key?: string;
|
|
713
|
+
/** OAuth 2.0 token for the current user. */
|
|
714
|
+
oauth_token?: string;
|
|
715
|
+
/**
|
|
716
|
+
* The resource name of the parent AndroidApp for which to list each associated ShaCertificate, in the format: projects/PROJECT_IDENTIFIER /androidApps/APP_ID Since an APP_ID is a
|
|
717
|
+
* unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/androidApps/APP_ID Refer to the `AndroidApp`
|
|
718
|
+
* [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
719
|
+
*/
|
|
720
|
+
parent: string;
|
|
721
|
+
/** Returns response with indentations and line breaks. */
|
|
722
|
+
prettyPrint?: boolean;
|
|
723
|
+
/** 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. */
|
|
724
|
+
quotaUser?: string;
|
|
725
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
726
|
+
upload_protocol?: string;
|
|
727
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
728
|
+
uploadType?: string;
|
|
729
|
+
}): Request<ListShaCertificatesResponse>;
|
|
730
|
+
}
|
|
731
|
+
interface AndroidAppsResource {
|
|
732
|
+
/**
|
|
733
|
+
* Requests the creation of a new AndroidApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The
|
|
734
|
+
* `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`.
|
|
735
|
+
*/
|
|
736
|
+
create(request: {
|
|
737
|
+
/** V1 error format. */
|
|
738
|
+
"$.xgafv"?: string;
|
|
739
|
+
/** OAuth access token. */
|
|
740
|
+
access_token?: string;
|
|
741
|
+
/** Data format for response. */
|
|
742
|
+
alt?: string;
|
|
743
|
+
/** JSONP */
|
|
744
|
+
callback?: string;
|
|
745
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
746
|
+
fields?: string;
|
|
747
|
+
/** 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. */
|
|
748
|
+
key?: string;
|
|
749
|
+
/** OAuth 2.0 token for the current user. */
|
|
750
|
+
oauth_token?: string;
|
|
751
|
+
/**
|
|
752
|
+
* The resource name of the parent FirebaseProject in which to create an AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps Refer to the `FirebaseProject`
|
|
753
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
754
|
+
*/
|
|
755
|
+
parent: string;
|
|
756
|
+
/** Returns response with indentations and line breaks. */
|
|
757
|
+
prettyPrint?: boolean;
|
|
758
|
+
/** 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. */
|
|
759
|
+
quotaUser?: string;
|
|
760
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
761
|
+
upload_protocol?: string;
|
|
762
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
763
|
+
uploadType?: string;
|
|
764
|
+
/** Request body */
|
|
765
|
+
resource: AndroidApp;
|
|
766
|
+
}): Request<Operation>;
|
|
767
|
+
create(request: {
|
|
768
|
+
/** V1 error format. */
|
|
769
|
+
"$.xgafv"?: string;
|
|
770
|
+
/** OAuth access token. */
|
|
771
|
+
access_token?: string;
|
|
772
|
+
/** Data format for response. */
|
|
773
|
+
alt?: string;
|
|
774
|
+
/** JSONP */
|
|
775
|
+
callback?: string;
|
|
776
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
777
|
+
fields?: string;
|
|
778
|
+
/** 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. */
|
|
779
|
+
key?: string;
|
|
780
|
+
/** OAuth 2.0 token for the current user. */
|
|
781
|
+
oauth_token?: string;
|
|
782
|
+
/**
|
|
783
|
+
* The resource name of the parent FirebaseProject in which to create an AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps Refer to the `FirebaseProject`
|
|
784
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
785
|
+
*/
|
|
786
|
+
parent: string;
|
|
787
|
+
/** Returns response with indentations and line breaks. */
|
|
788
|
+
prettyPrint?: boolean;
|
|
789
|
+
/** 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. */
|
|
790
|
+
quotaUser?: string;
|
|
791
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
792
|
+
upload_protocol?: string;
|
|
793
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
794
|
+
uploadType?: string;
|
|
795
|
+
},
|
|
796
|
+
body: AndroidApp): Request<Operation>;
|
|
797
|
+
/** Gets the specified AndroidApp. */
|
|
798
|
+
get(request?: {
|
|
799
|
+
/** V1 error format. */
|
|
800
|
+
"$.xgafv"?: string;
|
|
801
|
+
/** OAuth access token. */
|
|
802
|
+
access_token?: string;
|
|
803
|
+
/** Data format for response. */
|
|
804
|
+
alt?: string;
|
|
805
|
+
/** JSONP */
|
|
806
|
+
callback?: string;
|
|
807
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
808
|
+
fields?: string;
|
|
809
|
+
/** 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. */
|
|
810
|
+
key?: string;
|
|
811
|
+
/**
|
|
812
|
+
* The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from
|
|
813
|
+
* Sub-Collection access pattern may be used here, in the format: projects/-/androidApps/APP_ID Refer to the `AndroidApp` [`name`](../projects.androidApps#AndroidApp.FIELDS.name)
|
|
814
|
+
* field for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
815
|
+
*/
|
|
816
|
+
name: string;
|
|
817
|
+
/** OAuth 2.0 token for the current user. */
|
|
818
|
+
oauth_token?: string;
|
|
819
|
+
/** Returns response with indentations and line breaks. */
|
|
820
|
+
prettyPrint?: boolean;
|
|
821
|
+
/** 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. */
|
|
822
|
+
quotaUser?: string;
|
|
823
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
824
|
+
upload_protocol?: string;
|
|
825
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
826
|
+
uploadType?: string;
|
|
827
|
+
}): Request<AndroidApp>;
|
|
828
|
+
/** Gets the configuration artifact associated with the specified AndroidApp. */
|
|
829
|
+
getConfig(request?: {
|
|
830
|
+
/** V1 error format. */
|
|
831
|
+
"$.xgafv"?: string;
|
|
832
|
+
/** OAuth access token. */
|
|
833
|
+
access_token?: string;
|
|
834
|
+
/** Data format for response. */
|
|
835
|
+
alt?: string;
|
|
836
|
+
/** JSONP */
|
|
837
|
+
callback?: string;
|
|
838
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
839
|
+
fields?: string;
|
|
840
|
+
/** 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. */
|
|
841
|
+
key?: string;
|
|
842
|
+
/**
|
|
843
|
+
* The resource name of the AndroidApp configuration to download, in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID/config Since an APP_ID is a unique identifier, the
|
|
844
|
+
* Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/androidApps/APP_ID Refer to the `AndroidApp`
|
|
845
|
+
* [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
846
|
+
*/
|
|
847
|
+
name: string;
|
|
848
|
+
/** OAuth 2.0 token for the current user. */
|
|
849
|
+
oauth_token?: string;
|
|
850
|
+
/** Returns response with indentations and line breaks. */
|
|
851
|
+
prettyPrint?: boolean;
|
|
852
|
+
/** 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. */
|
|
853
|
+
quotaUser?: string;
|
|
854
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
855
|
+
upload_protocol?: string;
|
|
856
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
857
|
+
uploadType?: string;
|
|
858
|
+
}): Request<AndroidAppConfig>;
|
|
859
|
+
/**
|
|
860
|
+
* Lists each AndroidApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional
|
|
861
|
+
* requests are made with a `pageToken`.
|
|
862
|
+
*/
|
|
863
|
+
list(request?: {
|
|
864
|
+
/** V1 error format. */
|
|
865
|
+
"$.xgafv"?: string;
|
|
866
|
+
/** OAuth access token. */
|
|
867
|
+
access_token?: string;
|
|
868
|
+
/** Data format for response. */
|
|
869
|
+
alt?: string;
|
|
870
|
+
/** JSONP */
|
|
871
|
+
callback?: string;
|
|
872
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
873
|
+
fields?: string;
|
|
874
|
+
/** 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. */
|
|
875
|
+
key?: string;
|
|
876
|
+
/** OAuth 2.0 token for the current user. */
|
|
877
|
+
oauth_token?: string;
|
|
878
|
+
/**
|
|
879
|
+
* The maximum number of Apps to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), then
|
|
880
|
+
* the server will impose its own limit.
|
|
881
|
+
*/
|
|
882
|
+
pageSize?: number;
|
|
883
|
+
/** Token returned from a previous call to `ListAndroidApps` indicating where in the set of Apps to resume listing. */
|
|
884
|
+
pageToken?: string;
|
|
885
|
+
/**
|
|
886
|
+
* The resource name of the parent FirebaseProject for which to list each associated AndroidApp, in the format: projects/PROJECT_IDENTIFIER /androidApps Refer to the
|
|
887
|
+
* `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
888
|
+
*/
|
|
889
|
+
parent: string;
|
|
890
|
+
/** Returns response with indentations and line breaks. */
|
|
891
|
+
prettyPrint?: boolean;
|
|
892
|
+
/** 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. */
|
|
893
|
+
quotaUser?: string;
|
|
894
|
+
/** Controls whether Apps in the DELETED state should be returned. Defaults to false. */
|
|
895
|
+
showDeleted?: boolean;
|
|
896
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
897
|
+
upload_protocol?: string;
|
|
898
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
899
|
+
uploadType?: string;
|
|
900
|
+
}): Request<ListAndroidAppsResponse>;
|
|
901
|
+
/** Updates the attributes of the specified AndroidApp. */
|
|
902
|
+
patch(request: {
|
|
903
|
+
/** V1 error format. */
|
|
904
|
+
"$.xgafv"?: string;
|
|
905
|
+
/** OAuth access token. */
|
|
906
|
+
access_token?: string;
|
|
907
|
+
/** Data format for response. */
|
|
908
|
+
alt?: string;
|
|
909
|
+
/** JSONP */
|
|
910
|
+
callback?: string;
|
|
911
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
912
|
+
fields?: string;
|
|
913
|
+
/** 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. */
|
|
914
|
+
key?: string;
|
|
915
|
+
/**
|
|
916
|
+
* The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's
|
|
917
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
|
918
|
+
* using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the
|
|
919
|
+
* `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)).
|
|
920
|
+
*/
|
|
921
|
+
name: string;
|
|
922
|
+
/** OAuth 2.0 token for the current user. */
|
|
923
|
+
oauth_token?: string;
|
|
924
|
+
/** Returns response with indentations and line breaks. */
|
|
925
|
+
prettyPrint?: boolean;
|
|
926
|
+
/** 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. */
|
|
927
|
+
quotaUser?: string;
|
|
928
|
+
/** Specifies which fields to update. Note that the fields `name`, `app_id`, `project_id`, `package_name`, and `state` are all immutable. */
|
|
929
|
+
updateMask?: string;
|
|
930
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
931
|
+
upload_protocol?: string;
|
|
932
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
933
|
+
uploadType?: string;
|
|
934
|
+
/** Request body */
|
|
935
|
+
resource: AndroidApp;
|
|
936
|
+
}): Request<AndroidApp>;
|
|
937
|
+
patch(request: {
|
|
938
|
+
/** V1 error format. */
|
|
939
|
+
"$.xgafv"?: string;
|
|
940
|
+
/** OAuth access token. */
|
|
941
|
+
access_token?: string;
|
|
942
|
+
/** Data format for response. */
|
|
943
|
+
alt?: string;
|
|
944
|
+
/** JSONP */
|
|
945
|
+
callback?: string;
|
|
946
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
947
|
+
fields?: string;
|
|
948
|
+
/** 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. */
|
|
949
|
+
key?: string;
|
|
950
|
+
/**
|
|
951
|
+
* The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's
|
|
952
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
|
953
|
+
* using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the
|
|
954
|
+
* `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)).
|
|
955
|
+
*/
|
|
956
|
+
name: string;
|
|
957
|
+
/** OAuth 2.0 token for the current user. */
|
|
958
|
+
oauth_token?: string;
|
|
959
|
+
/** Returns response with indentations and line breaks. */
|
|
960
|
+
prettyPrint?: boolean;
|
|
961
|
+
/** 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. */
|
|
962
|
+
quotaUser?: string;
|
|
963
|
+
/** Specifies which fields to update. Note that the fields `name`, `app_id`, `project_id`, `package_name`, and `state` are all immutable. */
|
|
964
|
+
updateMask?: string;
|
|
965
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
966
|
+
upload_protocol?: string;
|
|
967
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
968
|
+
uploadType?: string;
|
|
969
|
+
},
|
|
970
|
+
body: AndroidApp): Request<AndroidApp>;
|
|
971
|
+
/** Removes the specified AndroidApp from the project. */
|
|
972
|
+
remove(request: {
|
|
973
|
+
/** V1 error format. */
|
|
974
|
+
"$.xgafv"?: string;
|
|
975
|
+
/** OAuth access token. */
|
|
976
|
+
access_token?: string;
|
|
977
|
+
/** Data format for response. */
|
|
978
|
+
alt?: string;
|
|
979
|
+
/** JSONP */
|
|
980
|
+
callback?: string;
|
|
981
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
982
|
+
fields?: string;
|
|
983
|
+
/** 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. */
|
|
984
|
+
key?: string;
|
|
985
|
+
/**
|
|
986
|
+
* Required. The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from
|
|
987
|
+
* Sub-Collection access pattern may be used here, in the format: projects/-/androidApps/APP_ID Refer to the AndroidApp [name](../projects.androidApps#AndroidApp.FIELDS.name) field
|
|
988
|
+
* for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
989
|
+
*/
|
|
990
|
+
name: string;
|
|
991
|
+
/** OAuth 2.0 token for the current user. */
|
|
992
|
+
oauth_token?: string;
|
|
993
|
+
/** Returns response with indentations and line breaks. */
|
|
994
|
+
prettyPrint?: boolean;
|
|
995
|
+
/** 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. */
|
|
996
|
+
quotaUser?: string;
|
|
997
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
998
|
+
upload_protocol?: string;
|
|
999
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1000
|
+
uploadType?: string;
|
|
1001
|
+
/** Request body */
|
|
1002
|
+
resource: RemoveAndroidAppRequest;
|
|
1003
|
+
}): Request<Operation>;
|
|
1004
|
+
remove(request: {
|
|
1005
|
+
/** V1 error format. */
|
|
1006
|
+
"$.xgafv"?: string;
|
|
1007
|
+
/** OAuth access token. */
|
|
1008
|
+
access_token?: string;
|
|
1009
|
+
/** Data format for response. */
|
|
1010
|
+
alt?: string;
|
|
1011
|
+
/** JSONP */
|
|
1012
|
+
callback?: string;
|
|
1013
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1014
|
+
fields?: string;
|
|
1015
|
+
/** 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. */
|
|
1016
|
+
key?: string;
|
|
1017
|
+
/**
|
|
1018
|
+
* Required. The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from
|
|
1019
|
+
* Sub-Collection access pattern may be used here, in the format: projects/-/androidApps/APP_ID Refer to the AndroidApp [name](../projects.androidApps#AndroidApp.FIELDS.name) field
|
|
1020
|
+
* for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
1021
|
+
*/
|
|
1022
|
+
name: string;
|
|
1023
|
+
/** OAuth 2.0 token for the current user. */
|
|
1024
|
+
oauth_token?: string;
|
|
1025
|
+
/** Returns response with indentations and line breaks. */
|
|
1026
|
+
prettyPrint?: boolean;
|
|
1027
|
+
/** 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. */
|
|
1028
|
+
quotaUser?: string;
|
|
1029
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1030
|
+
upload_protocol?: string;
|
|
1031
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1032
|
+
uploadType?: string;
|
|
1033
|
+
},
|
|
1034
|
+
body: RemoveAndroidAppRequest): Request<Operation>;
|
|
1035
|
+
sha: ShaResource;
|
|
1036
|
+
}
|
|
1037
|
+
interface AvailableLocationsResource {
|
|
1038
|
+
/**
|
|
1039
|
+
* Lists the valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project's
|
|
1040
|
+
* [_default_ GCP resource location](https://firebase.google.com/docs/projects/locations), which is the geographical location where the Project's resources, such as Cloud Firestore,
|
|
1041
|
+
* will be provisioned by default. However, if the default GCP resource location has already been set for the Project, then this setting cannot be changed. This call checks for any
|
|
1042
|
+
* possible [location restrictions](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations) for the specified Project and, thus, might return a subset of
|
|
1043
|
+
* all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is,
|
|
1044
|
+
* `/v1beta1/{parent=projects/-}/listAvailableLocations`). To call `ListAvailableLocations` with a specified project, a member must be at minimum a Viewer of the Project. Calls without
|
|
1045
|
+
* a specified project do not require any specific project permissions.
|
|
1046
|
+
*/
|
|
1047
|
+
list(request?: {
|
|
1048
|
+
/** V1 error format. */
|
|
1049
|
+
"$.xgafv"?: string;
|
|
1050
|
+
/** OAuth access token. */
|
|
1051
|
+
access_token?: string;
|
|
1052
|
+
/** Data format for response. */
|
|
1053
|
+
alt?: string;
|
|
1054
|
+
/** JSONP */
|
|
1055
|
+
callback?: string;
|
|
1056
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1057
|
+
fields?: string;
|
|
1058
|
+
/** 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. */
|
|
1059
|
+
key?: string;
|
|
1060
|
+
/** OAuth 2.0 token for the current user. */
|
|
1061
|
+
oauth_token?: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* The maximum number of locations to return in the response. The server may return fewer than this value at its discretion. If no value is specified (or too large a value is
|
|
1064
|
+
* specified), then the server will impose its own limit. This value cannot be negative.
|
|
1065
|
+
*/
|
|
1066
|
+
pageSize?: number;
|
|
1067
|
+
/** Token returned from a previous call to `ListAvailableLocations` indicating where in the list of locations to resume listing. */
|
|
1068
|
+
pageToken?: string;
|
|
1069
|
+
/**
|
|
1070
|
+
* The FirebaseProject for which to list GCP resource locations, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject`
|
|
1071
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. If no unique project identifier is specified (that is, `projects/-`), the
|
|
1072
|
+
* returned list does not take into account org-specific or project-specific location restrictions.
|
|
1073
|
+
*/
|
|
1074
|
+
parent: string;
|
|
1075
|
+
/** Returns response with indentations and line breaks. */
|
|
1076
|
+
prettyPrint?: boolean;
|
|
1077
|
+
/** 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. */
|
|
1078
|
+
quotaUser?: string;
|
|
1079
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1080
|
+
upload_protocol?: string;
|
|
1081
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1082
|
+
uploadType?: string;
|
|
1083
|
+
}): Request<ListAvailableLocationsResponse>;
|
|
1084
|
+
}
|
|
1085
|
+
interface DefaultLocationResource {
|
|
1086
|
+
/**
|
|
1087
|
+
* Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject. This method creates an App Engine application with a [default Cloud Storage
|
|
1088
|
+
* bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified
|
|
1089
|
+
* [`locationId`](#body.request_body.FIELDS.location_id). This location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations).
|
|
1090
|
+
* After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified `FirebaseProject` might
|
|
1091
|
+
* already be set because either the underlying GCP `Project` already has an App Engine application or `FinalizeDefaultLocation` was previously called with a specified `locationId`.
|
|
1092
|
+
* Any new calls to `FinalizeDefaultLocation` with a *different* specified `locationId` will return a 409 error. The result of this call is an [`Operation`](../../v1beta1/operations),
|
|
1093
|
+
* which can be used to track the provisioning process. The [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of the `Operation` is google.protobuf.Empty. The
|
|
1094
|
+
* `Operation` can be polled by its `name` using GetOperation until `done` is true. When `done` is true, the `Operation` has either succeeded or failed. If the `Operation` has
|
|
1095
|
+
* succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) will be set to a google.protobuf.Empty; if the `Operation` has failed, its `error` will be set to a
|
|
1096
|
+
* google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. All fields listed in the [request body](#request-body) are
|
|
1097
|
+
* required. To call `FinalizeDefaultLocation`, a member must be an Owner of the Project.
|
|
1098
|
+
*/
|
|
1099
|
+
finalize(request: {
|
|
1100
|
+
/** V1 error format. */
|
|
1101
|
+
"$.xgafv"?: string;
|
|
1102
|
+
/** OAuth access token. */
|
|
1103
|
+
access_token?: string;
|
|
1104
|
+
/** Data format for response. */
|
|
1105
|
+
alt?: string;
|
|
1106
|
+
/** JSONP */
|
|
1107
|
+
callback?: string;
|
|
1108
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1109
|
+
fields?: string;
|
|
1110
|
+
/** 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. */
|
|
1111
|
+
key?: string;
|
|
1112
|
+
/** OAuth 2.0 token for the current user. */
|
|
1113
|
+
oauth_token?: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* The resource name of the FirebaseProject for which the default GCP resource location will be set, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject`
|
|
1116
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
1117
|
+
*/
|
|
1118
|
+
parent: string;
|
|
1119
|
+
/** Returns response with indentations and line breaks. */
|
|
1120
|
+
prettyPrint?: boolean;
|
|
1121
|
+
/** 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. */
|
|
1122
|
+
quotaUser?: string;
|
|
1123
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1124
|
+
upload_protocol?: string;
|
|
1125
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1126
|
+
uploadType?: string;
|
|
1127
|
+
/** Request body */
|
|
1128
|
+
resource: FinalizeDefaultLocationRequest;
|
|
1129
|
+
}): Request<Operation>;
|
|
1130
|
+
finalize(request: {
|
|
1131
|
+
/** V1 error format. */
|
|
1132
|
+
"$.xgafv"?: string;
|
|
1133
|
+
/** OAuth access token. */
|
|
1134
|
+
access_token?: string;
|
|
1135
|
+
/** Data format for response. */
|
|
1136
|
+
alt?: string;
|
|
1137
|
+
/** JSONP */
|
|
1138
|
+
callback?: string;
|
|
1139
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1140
|
+
fields?: string;
|
|
1141
|
+
/** 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. */
|
|
1142
|
+
key?: string;
|
|
1143
|
+
/** OAuth 2.0 token for the current user. */
|
|
1144
|
+
oauth_token?: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* The resource name of the FirebaseProject for which the default GCP resource location will be set, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject`
|
|
1147
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
1148
|
+
*/
|
|
1149
|
+
parent: string;
|
|
1150
|
+
/** Returns response with indentations and line breaks. */
|
|
1151
|
+
prettyPrint?: boolean;
|
|
1152
|
+
/** 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. */
|
|
1153
|
+
quotaUser?: string;
|
|
1154
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1155
|
+
upload_protocol?: string;
|
|
1156
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1157
|
+
uploadType?: string;
|
|
1158
|
+
},
|
|
1159
|
+
body: FinalizeDefaultLocationRequest): Request<Operation>;
|
|
1160
|
+
}
|
|
1161
|
+
interface IosAppsResource {
|
|
1162
|
+
/**
|
|
1163
|
+
* Requests the creation of a new IosApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The
|
|
1164
|
+
* `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`.
|
|
1165
|
+
*/
|
|
1166
|
+
create(request: {
|
|
1167
|
+
/** V1 error format. */
|
|
1168
|
+
"$.xgafv"?: string;
|
|
1169
|
+
/** OAuth access token. */
|
|
1170
|
+
access_token?: string;
|
|
1171
|
+
/** Data format for response. */
|
|
1172
|
+
alt?: string;
|
|
1173
|
+
/** JSONP */
|
|
1174
|
+
callback?: string;
|
|
1175
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1176
|
+
fields?: string;
|
|
1177
|
+
/** 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. */
|
|
1178
|
+
key?: string;
|
|
1179
|
+
/** OAuth 2.0 token for the current user. */
|
|
1180
|
+
oauth_token?: string;
|
|
1181
|
+
/**
|
|
1182
|
+
* The resource name of the parent FirebaseProject in which to create an IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the `FirebaseProject`
|
|
1183
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
1184
|
+
*/
|
|
1185
|
+
parent: string;
|
|
1186
|
+
/** Returns response with indentations and line breaks. */
|
|
1187
|
+
prettyPrint?: boolean;
|
|
1188
|
+
/** 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. */
|
|
1189
|
+
quotaUser?: string;
|
|
1190
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1191
|
+
upload_protocol?: string;
|
|
1192
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1193
|
+
uploadType?: string;
|
|
1194
|
+
/** Request body */
|
|
1195
|
+
resource: IosApp;
|
|
1196
|
+
}): Request<Operation>;
|
|
1197
|
+
create(request: {
|
|
1198
|
+
/** V1 error format. */
|
|
1199
|
+
"$.xgafv"?: string;
|
|
1200
|
+
/** OAuth access token. */
|
|
1201
|
+
access_token?: string;
|
|
1202
|
+
/** Data format for response. */
|
|
1203
|
+
alt?: string;
|
|
1204
|
+
/** JSONP */
|
|
1205
|
+
callback?: string;
|
|
1206
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1207
|
+
fields?: string;
|
|
1208
|
+
/** 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. */
|
|
1209
|
+
key?: string;
|
|
1210
|
+
/** OAuth 2.0 token for the current user. */
|
|
1211
|
+
oauth_token?: string;
|
|
1212
|
+
/**
|
|
1213
|
+
* The resource name of the parent FirebaseProject in which to create an IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the `FirebaseProject`
|
|
1214
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
1215
|
+
*/
|
|
1216
|
+
parent: string;
|
|
1217
|
+
/** Returns response with indentations and line breaks. */
|
|
1218
|
+
prettyPrint?: boolean;
|
|
1219
|
+
/** 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. */
|
|
1220
|
+
quotaUser?: string;
|
|
1221
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1222
|
+
upload_protocol?: string;
|
|
1223
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1224
|
+
uploadType?: string;
|
|
1225
|
+
},
|
|
1226
|
+
body: IosApp): Request<Operation>;
|
|
1227
|
+
/** Gets the specified IosApp. */
|
|
1228
|
+
get(request?: {
|
|
1229
|
+
/** V1 error format. */
|
|
1230
|
+
"$.xgafv"?: string;
|
|
1231
|
+
/** OAuth access token. */
|
|
1232
|
+
access_token?: string;
|
|
1233
|
+
/** Data format for response. */
|
|
1234
|
+
alt?: string;
|
|
1235
|
+
/** JSONP */
|
|
1236
|
+
callback?: string;
|
|
1237
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1238
|
+
fields?: string;
|
|
1239
|
+
/** 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. */
|
|
1240
|
+
key?: string;
|
|
1241
|
+
/**
|
|
1242
|
+
* The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection
|
|
1243
|
+
* access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the `IosApp` [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details about
|
|
1244
|
+
* PROJECT_IDENTIFIER and APP_ID values.
|
|
1245
|
+
*/
|
|
1246
|
+
name: string;
|
|
1247
|
+
/** OAuth 2.0 token for the current user. */
|
|
1248
|
+
oauth_token?: string;
|
|
1249
|
+
/** Returns response with indentations and line breaks. */
|
|
1250
|
+
prettyPrint?: boolean;
|
|
1251
|
+
/** 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. */
|
|
1252
|
+
quotaUser?: string;
|
|
1253
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1254
|
+
upload_protocol?: string;
|
|
1255
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1256
|
+
uploadType?: string;
|
|
1257
|
+
}): Request<IosApp>;
|
|
1258
|
+
/** Gets the configuration artifact associated with the specified IosApp. */
|
|
1259
|
+
getConfig(request?: {
|
|
1260
|
+
/** V1 error format. */
|
|
1261
|
+
"$.xgafv"?: string;
|
|
1262
|
+
/** OAuth access token. */
|
|
1263
|
+
access_token?: string;
|
|
1264
|
+
/** Data format for response. */
|
|
1265
|
+
alt?: string;
|
|
1266
|
+
/** JSONP */
|
|
1267
|
+
callback?: string;
|
|
1268
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1269
|
+
fields?: string;
|
|
1270
|
+
/** 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. */
|
|
1271
|
+
key?: string;
|
|
1272
|
+
/**
|
|
1273
|
+
* The resource name of the App configuration to download, in the format: projects/PROJECT_IDENTIFIER/iosApps/APP_ID/config Since an APP_ID is a unique identifier, the Unique
|
|
1274
|
+
* Resource from Sub-Collection access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the `IosApp` [`name`](../projects.iosApps#IosApp.FIELDS.name)
|
|
1275
|
+
* field for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
1276
|
+
*/
|
|
1277
|
+
name: string;
|
|
1278
|
+
/** OAuth 2.0 token for the current user. */
|
|
1279
|
+
oauth_token?: string;
|
|
1280
|
+
/** Returns response with indentations and line breaks. */
|
|
1281
|
+
prettyPrint?: boolean;
|
|
1282
|
+
/** 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. */
|
|
1283
|
+
quotaUser?: string;
|
|
1284
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1285
|
+
upload_protocol?: string;
|
|
1286
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1287
|
+
uploadType?: string;
|
|
1288
|
+
}): Request<IosAppConfig>;
|
|
1289
|
+
/**
|
|
1290
|
+
* Lists each IosApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests
|
|
1291
|
+
* are made with a `pageToken`.
|
|
1292
|
+
*/
|
|
1293
|
+
list(request?: {
|
|
1294
|
+
/** V1 error format. */
|
|
1295
|
+
"$.xgafv"?: string;
|
|
1296
|
+
/** OAuth access token. */
|
|
1297
|
+
access_token?: string;
|
|
1298
|
+
/** Data format for response. */
|
|
1299
|
+
alt?: string;
|
|
1300
|
+
/** JSONP */
|
|
1301
|
+
callback?: string;
|
|
1302
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1303
|
+
fields?: string;
|
|
1304
|
+
/** 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. */
|
|
1305
|
+
key?: string;
|
|
1306
|
+
/** OAuth 2.0 token for the current user. */
|
|
1307
|
+
oauth_token?: string;
|
|
1308
|
+
/**
|
|
1309
|
+
* The maximum number of Apps to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the
|
|
1310
|
+
* server will impose its own limit.
|
|
1311
|
+
*/
|
|
1312
|
+
pageSize?: number;
|
|
1313
|
+
/** Token returned from a previous call to `ListIosApps` indicating where in the set of Apps to resume listing. */
|
|
1314
|
+
pageToken?: string;
|
|
1315
|
+
/**
|
|
1316
|
+
* The resource name of the parent FirebaseProject for which to list each associated IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the `FirebaseProject`
|
|
1317
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
1318
|
+
*/
|
|
1319
|
+
parent: string;
|
|
1320
|
+
/** Returns response with indentations and line breaks. */
|
|
1321
|
+
prettyPrint?: boolean;
|
|
1322
|
+
/** 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. */
|
|
1323
|
+
quotaUser?: string;
|
|
1324
|
+
/** Controls whether Apps in the DELETED state should be returned. Defaults to false. */
|
|
1325
|
+
showDeleted?: boolean;
|
|
1326
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1327
|
+
upload_protocol?: string;
|
|
1328
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1329
|
+
uploadType?: string;
|
|
1330
|
+
}): Request<ListIosAppsResponse>;
|
|
1331
|
+
/** Updates the attributes of the specified IosApp. */
|
|
1332
|
+
patch(request: {
|
|
1333
|
+
/** V1 error format. */
|
|
1334
|
+
"$.xgafv"?: string;
|
|
1335
|
+
/** OAuth access token. */
|
|
1336
|
+
access_token?: string;
|
|
1337
|
+
/** Data format for response. */
|
|
1338
|
+
alt?: string;
|
|
1339
|
+
/** JSONP */
|
|
1340
|
+
callback?: string;
|
|
1341
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1342
|
+
fields?: string;
|
|
1343
|
+
/** 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. */
|
|
1344
|
+
key?: string;
|
|
1345
|
+
/**
|
|
1346
|
+
* The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's
|
|
1347
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
|
1348
|
+
* using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the
|
|
1349
|
+
* `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
|
|
1350
|
+
*/
|
|
1351
|
+
name: string;
|
|
1352
|
+
/** OAuth 2.0 token for the current user. */
|
|
1353
|
+
oauth_token?: string;
|
|
1354
|
+
/** Returns response with indentations and line breaks. */
|
|
1355
|
+
prettyPrint?: boolean;
|
|
1356
|
+
/** 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. */
|
|
1357
|
+
quotaUser?: string;
|
|
1358
|
+
/** Specifies which fields to update. Note that the fields `name`, `appId`, `projectId`, `bundleId`, and `state` are all immutable */
|
|
1359
|
+
updateMask?: string;
|
|
1360
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1361
|
+
upload_protocol?: string;
|
|
1362
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1363
|
+
uploadType?: string;
|
|
1364
|
+
/** Request body */
|
|
1365
|
+
resource: IosApp;
|
|
1366
|
+
}): Request<IosApp>;
|
|
1367
|
+
patch(request: {
|
|
1368
|
+
/** V1 error format. */
|
|
1369
|
+
"$.xgafv"?: string;
|
|
1370
|
+
/** OAuth access token. */
|
|
1371
|
+
access_token?: string;
|
|
1372
|
+
/** Data format for response. */
|
|
1373
|
+
alt?: string;
|
|
1374
|
+
/** JSONP */
|
|
1375
|
+
callback?: string;
|
|
1376
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1377
|
+
fields?: string;
|
|
1378
|
+
/** 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. */
|
|
1379
|
+
key?: string;
|
|
1380
|
+
/**
|
|
1381
|
+
* The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's
|
|
1382
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
|
1383
|
+
* using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the
|
|
1384
|
+
* `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
|
|
1385
|
+
*/
|
|
1386
|
+
name: string;
|
|
1387
|
+
/** OAuth 2.0 token for the current user. */
|
|
1388
|
+
oauth_token?: string;
|
|
1389
|
+
/** Returns response with indentations and line breaks. */
|
|
1390
|
+
prettyPrint?: boolean;
|
|
1391
|
+
/** 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. */
|
|
1392
|
+
quotaUser?: string;
|
|
1393
|
+
/** Specifies which fields to update. Note that the fields `name`, `appId`, `projectId`, `bundleId`, and `state` are all immutable */
|
|
1394
|
+
updateMask?: string;
|
|
1395
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1396
|
+
upload_protocol?: string;
|
|
1397
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1398
|
+
uploadType?: string;
|
|
1399
|
+
},
|
|
1400
|
+
body: IosApp): Request<IosApp>;
|
|
1401
|
+
/** Removes the specified IosApp from the project. */
|
|
1402
|
+
remove(request: {
|
|
1403
|
+
/** V1 error format. */
|
|
1404
|
+
"$.xgafv"?: string;
|
|
1405
|
+
/** OAuth access token. */
|
|
1406
|
+
access_token?: string;
|
|
1407
|
+
/** Data format for response. */
|
|
1408
|
+
alt?: string;
|
|
1409
|
+
/** JSONP */
|
|
1410
|
+
callback?: string;
|
|
1411
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1412
|
+
fields?: string;
|
|
1413
|
+
/** 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. */
|
|
1414
|
+
key?: string;
|
|
1415
|
+
/**
|
|
1416
|
+
* Required. The resource name of the IosApp, in the format: projects/ PROJECT_IDENTIFIER/iosApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from
|
|
1417
|
+
* Sub-Collection access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the IosApp [name](../projects.iosApps#IosApp.FIELDS.name) field for details
|
|
1418
|
+
* about PROJECT_IDENTIFIER and APP_ID values.
|
|
1419
|
+
*/
|
|
1420
|
+
name: string;
|
|
1421
|
+
/** OAuth 2.0 token for the current user. */
|
|
1422
|
+
oauth_token?: string;
|
|
1423
|
+
/** Returns response with indentations and line breaks. */
|
|
1424
|
+
prettyPrint?: boolean;
|
|
1425
|
+
/** 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. */
|
|
1426
|
+
quotaUser?: string;
|
|
1427
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1428
|
+
upload_protocol?: string;
|
|
1429
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1430
|
+
uploadType?: string;
|
|
1431
|
+
/** Request body */
|
|
1432
|
+
resource: RemoveIosAppRequest;
|
|
1433
|
+
}): Request<Operation>;
|
|
1434
|
+
remove(request: {
|
|
1435
|
+
/** V1 error format. */
|
|
1436
|
+
"$.xgafv"?: string;
|
|
1437
|
+
/** OAuth access token. */
|
|
1438
|
+
access_token?: string;
|
|
1439
|
+
/** Data format for response. */
|
|
1440
|
+
alt?: string;
|
|
1441
|
+
/** JSONP */
|
|
1442
|
+
callback?: string;
|
|
1443
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1444
|
+
fields?: string;
|
|
1445
|
+
/** 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. */
|
|
1446
|
+
key?: string;
|
|
1447
|
+
/**
|
|
1448
|
+
* Required. The resource name of the IosApp, in the format: projects/ PROJECT_IDENTIFIER/iosApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from
|
|
1449
|
+
* Sub-Collection access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the IosApp [name](../projects.iosApps#IosApp.FIELDS.name) field for details
|
|
1450
|
+
* about PROJECT_IDENTIFIER and APP_ID values.
|
|
1451
|
+
*/
|
|
1452
|
+
name: string;
|
|
1453
|
+
/** OAuth 2.0 token for the current user. */
|
|
1454
|
+
oauth_token?: string;
|
|
1455
|
+
/** Returns response with indentations and line breaks. */
|
|
1456
|
+
prettyPrint?: boolean;
|
|
1457
|
+
/** 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. */
|
|
1458
|
+
quotaUser?: string;
|
|
1459
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1460
|
+
upload_protocol?: string;
|
|
1461
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1462
|
+
uploadType?: string;
|
|
1463
|
+
},
|
|
1464
|
+
body: RemoveIosAppRequest): Request<Operation>;
|
|
1465
|
+
}
|
|
1466
|
+
interface WebAppsResource {
|
|
1467
|
+
/**
|
|
1468
|
+
* Requests the creation of a new WebApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The
|
|
1469
|
+
* `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`.
|
|
1470
|
+
*/
|
|
1471
|
+
create(request: {
|
|
1472
|
+
/** V1 error format. */
|
|
1473
|
+
"$.xgafv"?: string;
|
|
1474
|
+
/** OAuth access token. */
|
|
1475
|
+
access_token?: string;
|
|
1476
|
+
/** Data format for response. */
|
|
1477
|
+
alt?: string;
|
|
1478
|
+
/** JSONP */
|
|
1479
|
+
callback?: string;
|
|
1480
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1481
|
+
fields?: string;
|
|
1482
|
+
/** 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. */
|
|
1483
|
+
key?: string;
|
|
1484
|
+
/** OAuth 2.0 token for the current user. */
|
|
1485
|
+
oauth_token?: string;
|
|
1486
|
+
/**
|
|
1487
|
+
* The resource name of the parent FirebaseProject in which to create a WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to the `FirebaseProject`
|
|
1488
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
1489
|
+
*/
|
|
1490
|
+
parent: string;
|
|
1491
|
+
/** Returns response with indentations and line breaks. */
|
|
1492
|
+
prettyPrint?: boolean;
|
|
1493
|
+
/** 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. */
|
|
1494
|
+
quotaUser?: string;
|
|
1495
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1496
|
+
upload_protocol?: string;
|
|
1497
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1498
|
+
uploadType?: string;
|
|
1499
|
+
/** Request body */
|
|
1500
|
+
resource: WebApp;
|
|
1501
|
+
}): Request<Operation>;
|
|
1502
|
+
create(request: {
|
|
1503
|
+
/** V1 error format. */
|
|
1504
|
+
"$.xgafv"?: string;
|
|
1505
|
+
/** OAuth access token. */
|
|
1506
|
+
access_token?: string;
|
|
1507
|
+
/** Data format for response. */
|
|
1508
|
+
alt?: string;
|
|
1509
|
+
/** JSONP */
|
|
1510
|
+
callback?: string;
|
|
1511
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1512
|
+
fields?: string;
|
|
1513
|
+
/** 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. */
|
|
1514
|
+
key?: string;
|
|
1515
|
+
/** OAuth 2.0 token for the current user. */
|
|
1516
|
+
oauth_token?: string;
|
|
1517
|
+
/**
|
|
1518
|
+
* The resource name of the parent FirebaseProject in which to create a WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to the `FirebaseProject`
|
|
1519
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
1520
|
+
*/
|
|
1521
|
+
parent: string;
|
|
1522
|
+
/** Returns response with indentations and line breaks. */
|
|
1523
|
+
prettyPrint?: boolean;
|
|
1524
|
+
/** 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. */
|
|
1525
|
+
quotaUser?: string;
|
|
1526
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1527
|
+
upload_protocol?: string;
|
|
1528
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1529
|
+
uploadType?: string;
|
|
1530
|
+
},
|
|
1531
|
+
body: WebApp): Request<Operation>;
|
|
1532
|
+
/** Gets the specified WebApp. */
|
|
1533
|
+
get(request?: {
|
|
1534
|
+
/** V1 error format. */
|
|
1535
|
+
"$.xgafv"?: string;
|
|
1536
|
+
/** OAuth access token. */
|
|
1537
|
+
access_token?: string;
|
|
1538
|
+
/** Data format for response. */
|
|
1539
|
+
alt?: string;
|
|
1540
|
+
/** JSONP */
|
|
1541
|
+
callback?: string;
|
|
1542
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1543
|
+
fields?: string;
|
|
1544
|
+
/** 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. */
|
|
1545
|
+
key?: string;
|
|
1546
|
+
/**
|
|
1547
|
+
* The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection
|
|
1548
|
+
* access pattern may be used here, in the format: projects/-/webApps/APP_ID Refer to the `WebApp` [`name`](../projects.webApps#WebApp.FIELDS.name) field for details about
|
|
1549
|
+
* PROJECT_IDENTIFIER and APP_ID values.
|
|
1550
|
+
*/
|
|
1551
|
+
name: string;
|
|
1552
|
+
/** OAuth 2.0 token for the current user. */
|
|
1553
|
+
oauth_token?: string;
|
|
1554
|
+
/** Returns response with indentations and line breaks. */
|
|
1555
|
+
prettyPrint?: boolean;
|
|
1556
|
+
/** 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. */
|
|
1557
|
+
quotaUser?: string;
|
|
1558
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1559
|
+
upload_protocol?: string;
|
|
1560
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1561
|
+
uploadType?: string;
|
|
1562
|
+
}): Request<WebApp>;
|
|
1563
|
+
/** Gets the configuration artifact associated with the specified WebApp. */
|
|
1564
|
+
getConfig(request?: {
|
|
1565
|
+
/** V1 error format. */
|
|
1566
|
+
"$.xgafv"?: string;
|
|
1567
|
+
/** OAuth access token. */
|
|
1568
|
+
access_token?: string;
|
|
1569
|
+
/** Data format for response. */
|
|
1570
|
+
alt?: string;
|
|
1571
|
+
/** JSONP */
|
|
1572
|
+
callback?: string;
|
|
1573
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1574
|
+
fields?: string;
|
|
1575
|
+
/** 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. */
|
|
1576
|
+
key?: string;
|
|
1577
|
+
/**
|
|
1578
|
+
* The resource name of the WebApp configuration to download, in the format: projects/PROJECT_IDENTIFIER/webApps/APP_ID/config Since an APP_ID is a unique identifier, the Unique
|
|
1579
|
+
* Resource from Sub-Collection access pattern may be used here, in the format: projects/-/webApps/APP_ID Refer to the `WebApp` [`name`](../projects.webApps#WebApp.FIELDS.name)
|
|
1580
|
+
* field for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
1581
|
+
*/
|
|
1582
|
+
name: string;
|
|
1583
|
+
/** OAuth 2.0 token for the current user. */
|
|
1584
|
+
oauth_token?: string;
|
|
1585
|
+
/** Returns response with indentations and line breaks. */
|
|
1586
|
+
prettyPrint?: boolean;
|
|
1587
|
+
/** 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. */
|
|
1588
|
+
quotaUser?: string;
|
|
1589
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1590
|
+
upload_protocol?: string;
|
|
1591
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1592
|
+
uploadType?: string;
|
|
1593
|
+
}): Request<WebAppConfig>;
|
|
1594
|
+
/**
|
|
1595
|
+
* Lists each WebApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests
|
|
1596
|
+
* are made with a `pageToken`.
|
|
1597
|
+
*/
|
|
1598
|
+
list(request?: {
|
|
1599
|
+
/** V1 error format. */
|
|
1600
|
+
"$.xgafv"?: string;
|
|
1601
|
+
/** OAuth access token. */
|
|
1602
|
+
access_token?: string;
|
|
1603
|
+
/** Data format for response. */
|
|
1604
|
+
alt?: string;
|
|
1605
|
+
/** JSONP */
|
|
1606
|
+
callback?: string;
|
|
1607
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1608
|
+
fields?: string;
|
|
1609
|
+
/** 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. */
|
|
1610
|
+
key?: string;
|
|
1611
|
+
/** OAuth 2.0 token for the current user. */
|
|
1612
|
+
oauth_token?: string;
|
|
1613
|
+
/**
|
|
1614
|
+
* The maximum number of Apps to return in the response. The server may return fewer than this value at its discretion. If no value is specified (or too large a value is
|
|
1615
|
+
* specified), then the server will impose its own limit.
|
|
1616
|
+
*/
|
|
1617
|
+
pageSize?: number;
|
|
1618
|
+
/** Token returned from a previous call to `ListWebApps` indicating where in the set of Apps to resume listing. */
|
|
1619
|
+
pageToken?: string;
|
|
1620
|
+
/**
|
|
1621
|
+
* The resource name of the parent FirebaseProject for which to list each associated WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to the `FirebaseProject`
|
|
1622
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
1623
|
+
*/
|
|
1624
|
+
parent: string;
|
|
1625
|
+
/** Returns response with indentations and line breaks. */
|
|
1626
|
+
prettyPrint?: boolean;
|
|
1627
|
+
/** 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. */
|
|
1628
|
+
quotaUser?: string;
|
|
1629
|
+
/** Controls whether Apps in the DELETED state should be returned. Defaults to false. */
|
|
1630
|
+
showDeleted?: boolean;
|
|
1631
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1632
|
+
upload_protocol?: string;
|
|
1633
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1634
|
+
uploadType?: string;
|
|
1635
|
+
}): Request<ListWebAppsResponse>;
|
|
1636
|
+
/** Updates the attributes of the specified WebApp. */
|
|
1637
|
+
patch(request: {
|
|
1638
|
+
/** V1 error format. */
|
|
1639
|
+
"$.xgafv"?: string;
|
|
1640
|
+
/** OAuth access token. */
|
|
1641
|
+
access_token?: string;
|
|
1642
|
+
/** Data format for response. */
|
|
1643
|
+
alt?: string;
|
|
1644
|
+
/** JSONP */
|
|
1645
|
+
callback?: string;
|
|
1646
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1647
|
+
fields?: string;
|
|
1648
|
+
/** 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. */
|
|
1649
|
+
key?: string;
|
|
1650
|
+
/**
|
|
1651
|
+
* The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's
|
|
1652
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
|
1653
|
+
* using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the
|
|
1654
|
+
* `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
|
|
1655
|
+
*/
|
|
1656
|
+
name: string;
|
|
1657
|
+
/** OAuth 2.0 token for the current user. */
|
|
1658
|
+
oauth_token?: string;
|
|
1659
|
+
/** Returns response with indentations and line breaks. */
|
|
1660
|
+
prettyPrint?: boolean;
|
|
1661
|
+
/** 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. */
|
|
1662
|
+
quotaUser?: string;
|
|
1663
|
+
/** Specifies which fields to update. Note that the fields `name`, `appId`, `projectId` and `state` are all immutable */
|
|
1664
|
+
updateMask?: string;
|
|
1665
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1666
|
+
upload_protocol?: string;
|
|
1667
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1668
|
+
uploadType?: string;
|
|
1669
|
+
/** Request body */
|
|
1670
|
+
resource: WebApp;
|
|
1671
|
+
}): Request<WebApp>;
|
|
1672
|
+
patch(request: {
|
|
1673
|
+
/** V1 error format. */
|
|
1674
|
+
"$.xgafv"?: string;
|
|
1675
|
+
/** OAuth access token. */
|
|
1676
|
+
access_token?: string;
|
|
1677
|
+
/** Data format for response. */
|
|
1678
|
+
alt?: string;
|
|
1679
|
+
/** JSONP */
|
|
1680
|
+
callback?: string;
|
|
1681
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1682
|
+
fields?: string;
|
|
1683
|
+
/** 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. */
|
|
1684
|
+
key?: string;
|
|
1685
|
+
/**
|
|
1686
|
+
* The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's
|
|
1687
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
|
1688
|
+
* using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the
|
|
1689
|
+
* `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
|
|
1690
|
+
*/
|
|
1691
|
+
name: string;
|
|
1692
|
+
/** OAuth 2.0 token for the current user. */
|
|
1693
|
+
oauth_token?: string;
|
|
1694
|
+
/** Returns response with indentations and line breaks. */
|
|
1695
|
+
prettyPrint?: boolean;
|
|
1696
|
+
/** 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. */
|
|
1697
|
+
quotaUser?: string;
|
|
1698
|
+
/** Specifies which fields to update. Note that the fields `name`, `appId`, `projectId` and `state` are all immutable */
|
|
1699
|
+
updateMask?: string;
|
|
1700
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1701
|
+
upload_protocol?: string;
|
|
1702
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1703
|
+
uploadType?: string;
|
|
1704
|
+
},
|
|
1705
|
+
body: WebApp): Request<WebApp>;
|
|
1706
|
+
/** Removes the specified WebApp from the project. */
|
|
1707
|
+
remove(request: {
|
|
1708
|
+
/** V1 error format. */
|
|
1709
|
+
"$.xgafv"?: string;
|
|
1710
|
+
/** OAuth access token. */
|
|
1711
|
+
access_token?: string;
|
|
1712
|
+
/** Data format for response. */
|
|
1713
|
+
alt?: string;
|
|
1714
|
+
/** JSONP */
|
|
1715
|
+
callback?: string;
|
|
1716
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1717
|
+
fields?: string;
|
|
1718
|
+
/** 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. */
|
|
1719
|
+
key?: string;
|
|
1720
|
+
/**
|
|
1721
|
+
* Required. The resource name of the WebApp, in the format: projects/ PROJECT_IDENTIFIER/webApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from
|
|
1722
|
+
* Sub-Collection access pattern may be used here, in the format: projects/-/webApps/APP_ID Refer to the WebApp [name](../projects.webApps#WebApp.FIELDS.name) field for details
|
|
1723
|
+
* about PROJECT_IDENTIFIER and APP_ID values.
|
|
1724
|
+
*/
|
|
1725
|
+
name: string;
|
|
1726
|
+
/** OAuth 2.0 token for the current user. */
|
|
1727
|
+
oauth_token?: string;
|
|
1728
|
+
/** Returns response with indentations and line breaks. */
|
|
1729
|
+
prettyPrint?: boolean;
|
|
1730
|
+
/** 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. */
|
|
1731
|
+
quotaUser?: string;
|
|
1732
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1733
|
+
upload_protocol?: string;
|
|
1734
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1735
|
+
uploadType?: string;
|
|
1736
|
+
/** Request body */
|
|
1737
|
+
resource: RemoveWebAppRequest;
|
|
1738
|
+
}): Request<Operation>;
|
|
1739
|
+
remove(request: {
|
|
1740
|
+
/** V1 error format. */
|
|
1741
|
+
"$.xgafv"?: string;
|
|
1742
|
+
/** OAuth access token. */
|
|
1743
|
+
access_token?: string;
|
|
1744
|
+
/** Data format for response. */
|
|
1745
|
+
alt?: string;
|
|
1746
|
+
/** JSONP */
|
|
1747
|
+
callback?: string;
|
|
1748
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1749
|
+
fields?: string;
|
|
1750
|
+
/** 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. */
|
|
1751
|
+
key?: string;
|
|
1752
|
+
/**
|
|
1753
|
+
* Required. The resource name of the WebApp, in the format: projects/ PROJECT_IDENTIFIER/webApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from
|
|
1754
|
+
* Sub-Collection access pattern may be used here, in the format: projects/-/webApps/APP_ID Refer to the WebApp [name](../projects.webApps#WebApp.FIELDS.name) field for details
|
|
1755
|
+
* about PROJECT_IDENTIFIER and APP_ID values.
|
|
1756
|
+
*/
|
|
1757
|
+
name: string;
|
|
1758
|
+
/** OAuth 2.0 token for the current user. */
|
|
1759
|
+
oauth_token?: string;
|
|
1760
|
+
/** Returns response with indentations and line breaks. */
|
|
1761
|
+
prettyPrint?: boolean;
|
|
1762
|
+
/** 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. */
|
|
1763
|
+
quotaUser?: string;
|
|
1764
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1765
|
+
upload_protocol?: string;
|
|
1766
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1767
|
+
uploadType?: string;
|
|
1768
|
+
},
|
|
1769
|
+
body: RemoveWebAppRequest): Request<Operation>;
|
|
1770
|
+
}
|
|
1771
|
+
interface ProjectsResource {
|
|
1772
|
+
/**
|
|
1773
|
+
* Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects). Since a
|
|
1774
|
+
* FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` has the same underlying GCP identifiers (`projectNumber` and `projectId`). This allows for easy interop with
|
|
1775
|
+
* Google APIs. The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until
|
|
1776
|
+
* [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its
|
|
1777
|
+
* [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to a FirebaseProject; if the `Operation` failed, its
|
|
1778
|
+
* [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call
|
|
1779
|
+
* DeleteOperation. This method does not modify any billing account information on the underlying GCP `Project`. To call `AddFirebase`, a project member or service account must have
|
|
1780
|
+
* the following permissions (the IAM roles of Editor and Owner contain these permissions): `firebase.projects.update`, `resourcemanager.projects.get`, `serviceusage.services.enable`,
|
|
1781
|
+
* and `serviceusage.services.get`.
|
|
1782
|
+
*/
|
|
1783
|
+
addFirebase(request: {
|
|
1784
|
+
/** V1 error format. */
|
|
1785
|
+
"$.xgafv"?: string;
|
|
1786
|
+
/** OAuth access token. */
|
|
1787
|
+
access_token?: string;
|
|
1788
|
+
/** Data format for response. */
|
|
1789
|
+
alt?: string;
|
|
1790
|
+
/** JSONP */
|
|
1791
|
+
callback?: string;
|
|
1792
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1793
|
+
fields?: string;
|
|
1794
|
+
/** 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. */
|
|
1795
|
+
key?: string;
|
|
1796
|
+
/** OAuth 2.0 token for the current user. */
|
|
1797
|
+
oauth_token?: string;
|
|
1798
|
+
/** Returns response with indentations and line breaks. */
|
|
1799
|
+
prettyPrint?: boolean;
|
|
1800
|
+
/**
|
|
1801
|
+
* The resource name of the GCP `Project` to which Firebase resources will be added, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject`
|
|
1802
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. After calling `AddFirebase`, the unique Project identifiers (
|
|
1803
|
+
* [`projectNumber`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_number) and
|
|
1804
|
+
* [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id)) of the underlying GCP `Project` are also the identifiers of the
|
|
1805
|
+
* FirebaseProject.
|
|
1806
|
+
*/
|
|
1807
|
+
project: string;
|
|
1808
|
+
/** 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. */
|
|
1809
|
+
quotaUser?: string;
|
|
1810
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1811
|
+
upload_protocol?: string;
|
|
1812
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1813
|
+
uploadType?: string;
|
|
1814
|
+
/** Request body */
|
|
1815
|
+
resource: AddFirebaseRequest;
|
|
1816
|
+
}): Request<Operation>;
|
|
1817
|
+
addFirebase(request: {
|
|
1818
|
+
/** V1 error format. */
|
|
1819
|
+
"$.xgafv"?: string;
|
|
1820
|
+
/** OAuth access token. */
|
|
1821
|
+
access_token?: string;
|
|
1822
|
+
/** Data format for response. */
|
|
1823
|
+
alt?: string;
|
|
1824
|
+
/** JSONP */
|
|
1825
|
+
callback?: string;
|
|
1826
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1827
|
+
fields?: string;
|
|
1828
|
+
/** 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. */
|
|
1829
|
+
key?: string;
|
|
1830
|
+
/** OAuth 2.0 token for the current user. */
|
|
1831
|
+
oauth_token?: string;
|
|
1832
|
+
/** Returns response with indentations and line breaks. */
|
|
1833
|
+
prettyPrint?: boolean;
|
|
1834
|
+
/**
|
|
1835
|
+
* The resource name of the GCP `Project` to which Firebase resources will be added, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject`
|
|
1836
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. After calling `AddFirebase`, the unique Project identifiers (
|
|
1837
|
+
* [`projectNumber`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_number) and
|
|
1838
|
+
* [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id)) of the underlying GCP `Project` are also the identifiers of the
|
|
1839
|
+
* FirebaseProject.
|
|
1840
|
+
*/
|
|
1841
|
+
project: string;
|
|
1842
|
+
/** 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. */
|
|
1843
|
+
quotaUser?: string;
|
|
1844
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1845
|
+
upload_protocol?: string;
|
|
1846
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1847
|
+
uploadType?: string;
|
|
1848
|
+
},
|
|
1849
|
+
body: AddFirebaseRequest): Request<Operation>;
|
|
1850
|
+
/**
|
|
1851
|
+
* Links the specified FirebaseProject with an existing [Google Analytics account](http://www.google.com/analytics/). Using this call, you can either: - Specify an `analyticsAccountId`
|
|
1852
|
+
* to provision a new Google Analytics property within the specified account and associate the new property with the `FirebaseProject`. - Specify an existing `analyticsPropertyId` to
|
|
1853
|
+
* associate the property with the `FirebaseProject`. Note that when you call `AddGoogleAnalytics`: 1. The first check determines if any existing data streams in the Google Analytics
|
|
1854
|
+
* property correspond to any existing Firebase Apps in the `FirebaseProject` (based on the `packageName` or `bundleId` associated with the data stream). Then, as applicable, the data
|
|
1855
|
+
* streams and apps are linked. Note that this auto-linking only applies to `AndroidApps` and `IosApps`. 2. If no corresponding data streams are found for the Firebase Apps, new data
|
|
1856
|
+
* streams are provisioned in the Google Analytics property for each of the Firebase Apps. Note that a new data stream is always provisioned for a Web App even if it was previously
|
|
1857
|
+
* associated with a data stream in the Analytics property. Learn more about the hierarchy and structure of Google Analytics accounts in the [Analytics
|
|
1858
|
+
* documentation](https://support.google.com/analytics/answer/9303323). The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the
|
|
1859
|
+
* provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or
|
|
1860
|
+
* failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to an AnalyticsDetails; if the `Operation` failed, its
|
|
1861
|
+
* [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. To call `AddGoogleAnalytics`, a project member must be an Owner for the existing
|
|
1862
|
+
* `FirebaseProject` and have the [`Edit` permission](https://support.google.com/analytics/answer/2884495) for the Google Analytics account. If the `FirebaseProject` already has Google
|
|
1863
|
+
* Analytics enabled, and you call `AddGoogleAnalytics` using an `analyticsPropertyId` that's different from the currently associated property, then the call will fail. Analytics may
|
|
1864
|
+
* have already been enabled in the Firebase console or by specifying `timeZone` and `regionCode` in the call to [`AddFirebase`](../../v1beta1/projects/addFirebase).
|
|
1865
|
+
*/
|
|
1866
|
+
addGoogleAnalytics(request: {
|
|
1867
|
+
/** V1 error format. */
|
|
1868
|
+
"$.xgafv"?: string;
|
|
1869
|
+
/** OAuth access token. */
|
|
1870
|
+
access_token?: string;
|
|
1871
|
+
/** Data format for response. */
|
|
1872
|
+
alt?: string;
|
|
1873
|
+
/** JSONP */
|
|
1874
|
+
callback?: string;
|
|
1875
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1876
|
+
fields?: string;
|
|
1877
|
+
/** 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. */
|
|
1878
|
+
key?: string;
|
|
1879
|
+
/** OAuth 2.0 token for the current user. */
|
|
1880
|
+
oauth_token?: string;
|
|
1881
|
+
/**
|
|
1882
|
+
* The resource name of the FirebaseProject to link to an existing Google Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject`
|
|
1883
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
1884
|
+
*/
|
|
1885
|
+
parent: string;
|
|
1886
|
+
/** Returns response with indentations and line breaks. */
|
|
1887
|
+
prettyPrint?: boolean;
|
|
1888
|
+
/** 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. */
|
|
1889
|
+
quotaUser?: string;
|
|
1890
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1891
|
+
upload_protocol?: string;
|
|
1892
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1893
|
+
uploadType?: string;
|
|
1894
|
+
/** Request body */
|
|
1895
|
+
resource: AddGoogleAnalyticsRequest;
|
|
1896
|
+
}): Request<Operation>;
|
|
1897
|
+
addGoogleAnalytics(request: {
|
|
1898
|
+
/** V1 error format. */
|
|
1899
|
+
"$.xgafv"?: string;
|
|
1900
|
+
/** OAuth access token. */
|
|
1901
|
+
access_token?: string;
|
|
1902
|
+
/** Data format for response. */
|
|
1903
|
+
alt?: string;
|
|
1904
|
+
/** JSONP */
|
|
1905
|
+
callback?: string;
|
|
1906
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1907
|
+
fields?: string;
|
|
1908
|
+
/** 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. */
|
|
1909
|
+
key?: string;
|
|
1910
|
+
/** OAuth 2.0 token for the current user. */
|
|
1911
|
+
oauth_token?: string;
|
|
1912
|
+
/**
|
|
1913
|
+
* The resource name of the FirebaseProject to link to an existing Google Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject`
|
|
1914
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
1915
|
+
*/
|
|
1916
|
+
parent: string;
|
|
1917
|
+
/** Returns response with indentations and line breaks. */
|
|
1918
|
+
prettyPrint?: boolean;
|
|
1919
|
+
/** 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. */
|
|
1920
|
+
quotaUser?: string;
|
|
1921
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1922
|
+
upload_protocol?: string;
|
|
1923
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1924
|
+
uploadType?: string;
|
|
1925
|
+
},
|
|
1926
|
+
body: AddGoogleAnalyticsRequest): Request<Operation>;
|
|
1927
|
+
/** Gets the specified FirebaseProject. */
|
|
1928
|
+
get(request?: {
|
|
1929
|
+
/** V1 error format. */
|
|
1930
|
+
"$.xgafv"?: string;
|
|
1931
|
+
/** OAuth access token. */
|
|
1932
|
+
access_token?: string;
|
|
1933
|
+
/** Data format for response. */
|
|
1934
|
+
alt?: string;
|
|
1935
|
+
/** JSONP */
|
|
1936
|
+
callback?: string;
|
|
1937
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1938
|
+
fields?: string;
|
|
1939
|
+
/** 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. */
|
|
1940
|
+
key?: string;
|
|
1941
|
+
/**
|
|
1942
|
+
* The resource name of the FirebaseProject, in the format: projects/ PROJECT_IDENTIFIER Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for
|
|
1943
|
+
* details about PROJECT_IDENTIFIER values.
|
|
1944
|
+
*/
|
|
1945
|
+
name: string;
|
|
1946
|
+
/** OAuth 2.0 token for the current user. */
|
|
1947
|
+
oauth_token?: string;
|
|
1948
|
+
/** Returns response with indentations and line breaks. */
|
|
1949
|
+
prettyPrint?: boolean;
|
|
1950
|
+
/** 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. */
|
|
1951
|
+
quotaUser?: string;
|
|
1952
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1953
|
+
upload_protocol?: string;
|
|
1954
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1955
|
+
uploadType?: string;
|
|
1956
|
+
}): Request<FirebaseProject>;
|
|
1957
|
+
/**
|
|
1958
|
+
* Gets the configuration artifact associated with the specified FirebaseProject, which can be used by servers to simplify initialization. Typically, this configuration is used with
|
|
1959
|
+
* the Firebase Admin SDK [initializeApp](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) command.
|
|
1960
|
+
*/
|
|
1961
|
+
getAdminSdkConfig(request?: {
|
|
1962
|
+
/** V1 error format. */
|
|
1963
|
+
"$.xgafv"?: string;
|
|
1964
|
+
/** OAuth access token. */
|
|
1965
|
+
access_token?: string;
|
|
1966
|
+
/** Data format for response. */
|
|
1967
|
+
alt?: string;
|
|
1968
|
+
/** JSONP */
|
|
1969
|
+
callback?: string;
|
|
1970
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1971
|
+
fields?: string;
|
|
1972
|
+
/** 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. */
|
|
1973
|
+
key?: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* The resource name of the FirebaseProject, in the format: projects/ PROJECT_IDENTIFIER/adminSdkConfig Refer to the `FirebaseProject`
|
|
1976
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
1977
|
+
*/
|
|
1978
|
+
name: string;
|
|
1979
|
+
/** OAuth 2.0 token for the current user. */
|
|
1980
|
+
oauth_token?: string;
|
|
1981
|
+
/** Returns response with indentations and line breaks. */
|
|
1982
|
+
prettyPrint?: boolean;
|
|
1983
|
+
/** 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. */
|
|
1984
|
+
quotaUser?: string;
|
|
1985
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1986
|
+
upload_protocol?: string;
|
|
1987
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1988
|
+
uploadType?: string;
|
|
1989
|
+
}): Request<AdminSdkConfig>;
|
|
1990
|
+
/**
|
|
1991
|
+
* Gets the Google Analytics details currently associated with the specified FirebaseProject. If the `FirebaseProject` is not yet linked to Google Analytics, then the response to
|
|
1992
|
+
* `GetAnalyticsDetails` is `NOT_FOUND`.
|
|
1993
|
+
*/
|
|
1994
|
+
getAnalyticsDetails(request?: {
|
|
1995
|
+
/** V1 error format. */
|
|
1996
|
+
"$.xgafv"?: string;
|
|
1997
|
+
/** OAuth access token. */
|
|
1998
|
+
access_token?: string;
|
|
1999
|
+
/** Data format for response. */
|
|
2000
|
+
alt?: string;
|
|
2001
|
+
/** JSONP */
|
|
2002
|
+
callback?: string;
|
|
2003
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2004
|
+
fields?: string;
|
|
2005
|
+
/** 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. */
|
|
2006
|
+
key?: string;
|
|
2007
|
+
/**
|
|
2008
|
+
* The resource name of the FirebaseProject, in the format: projects/ PROJECT_IDENTIFIER/analyticsDetails Refer to the `FirebaseProject`
|
|
2009
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
2010
|
+
*/
|
|
2011
|
+
name: string;
|
|
2012
|
+
/** OAuth 2.0 token for the current user. */
|
|
2013
|
+
oauth_token?: string;
|
|
2014
|
+
/** Returns response with indentations and line breaks. */
|
|
2015
|
+
prettyPrint?: boolean;
|
|
2016
|
+
/** 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. */
|
|
2017
|
+
quotaUser?: string;
|
|
2018
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2019
|
+
upload_protocol?: string;
|
|
2020
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2021
|
+
uploadType?: string;
|
|
2022
|
+
}): Request<AnalyticsDetails>;
|
|
2023
|
+
/**
|
|
2024
|
+
* Lists each FirebaseProject accessible to the caller. The elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests
|
|
2025
|
+
* are made with a `pageToken`. This method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might
|
|
2026
|
+
* not be reflected in the set of Projects. The list will include only ACTIVE Projects. Use GetFirebaseProject for consistent reads as well as for additional Project details.
|
|
2027
|
+
*/
|
|
2028
|
+
list(request?: {
|
|
2029
|
+
/** V1 error format. */
|
|
2030
|
+
"$.xgafv"?: string;
|
|
2031
|
+
/** OAuth access token. */
|
|
2032
|
+
access_token?: string;
|
|
2033
|
+
/** Data format for response. */
|
|
2034
|
+
alt?: string;
|
|
2035
|
+
/** JSONP */
|
|
2036
|
+
callback?: string;
|
|
2037
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2038
|
+
fields?: string;
|
|
2039
|
+
/** 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. */
|
|
2040
|
+
key?: string;
|
|
2041
|
+
/** OAuth 2.0 token for the current user. */
|
|
2042
|
+
oauth_token?: string;
|
|
2043
|
+
/**
|
|
2044
|
+
* The maximum number of Projects to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified),
|
|
2045
|
+
* the server will impose its own limit. This value cannot be negative.
|
|
2046
|
+
*/
|
|
2047
|
+
pageSize?: number;
|
|
2048
|
+
/** Token returned from a previous call to `ListFirebaseProjects` indicating where in the set of Projects to resume listing. */
|
|
2049
|
+
pageToken?: string;
|
|
2050
|
+
/** Returns response with indentations and line breaks. */
|
|
2051
|
+
prettyPrint?: boolean;
|
|
2052
|
+
/** 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. */
|
|
2053
|
+
quotaUser?: string;
|
|
2054
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2055
|
+
upload_protocol?: string;
|
|
2056
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2057
|
+
uploadType?: string;
|
|
2058
|
+
}): Request<ListFirebaseProjectsResponse>;
|
|
2059
|
+
/** Updates the attributes of the specified FirebaseProject. All [query parameters](#query-parameters) are required. */
|
|
2060
|
+
patch(request: {
|
|
2061
|
+
/** V1 error format. */
|
|
2062
|
+
"$.xgafv"?: string;
|
|
2063
|
+
/** OAuth access token. */
|
|
2064
|
+
access_token?: string;
|
|
2065
|
+
/** Data format for response. */
|
|
2066
|
+
alt?: string;
|
|
2067
|
+
/** JSONP */
|
|
2068
|
+
callback?: string;
|
|
2069
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2070
|
+
fields?: string;
|
|
2071
|
+
/** 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. */
|
|
2072
|
+
key?: string;
|
|
2073
|
+
/**
|
|
2074
|
+
* The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project's
|
|
2075
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
|
2076
|
+
* using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the
|
|
2077
|
+
* `ProjectId`.
|
|
2078
|
+
*/
|
|
2079
|
+
name: string;
|
|
2080
|
+
/** OAuth 2.0 token for the current user. */
|
|
2081
|
+
oauth_token?: string;
|
|
2082
|
+
/** Returns response with indentations and line breaks. */
|
|
2083
|
+
prettyPrint?: boolean;
|
|
2084
|
+
/** 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. */
|
|
2085
|
+
quotaUser?: string;
|
|
2086
|
+
/** Specifies which fields to update. If this list is empty, then no state will be updated. Note that the fields `name`, `projectId`, and `projectNumber` are all immutable. */
|
|
2087
|
+
updateMask?: string;
|
|
2088
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2089
|
+
upload_protocol?: string;
|
|
2090
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2091
|
+
uploadType?: string;
|
|
2092
|
+
/** Request body */
|
|
2093
|
+
resource: FirebaseProject;
|
|
2094
|
+
}): Request<FirebaseProject>;
|
|
2095
|
+
patch(request: {
|
|
2096
|
+
/** V1 error format. */
|
|
2097
|
+
"$.xgafv"?: string;
|
|
2098
|
+
/** OAuth access token. */
|
|
2099
|
+
access_token?: string;
|
|
2100
|
+
/** Data format for response. */
|
|
2101
|
+
alt?: string;
|
|
2102
|
+
/** JSONP */
|
|
2103
|
+
callback?: string;
|
|
2104
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2105
|
+
fields?: string;
|
|
2106
|
+
/** 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. */
|
|
2107
|
+
key?: string;
|
|
2108
|
+
/**
|
|
2109
|
+
* The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project's
|
|
2110
|
+
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
|
2111
|
+
* using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the
|
|
2112
|
+
* `ProjectId`.
|
|
2113
|
+
*/
|
|
2114
|
+
name: string;
|
|
2115
|
+
/** OAuth 2.0 token for the current user. */
|
|
2116
|
+
oauth_token?: string;
|
|
2117
|
+
/** Returns response with indentations and line breaks. */
|
|
2118
|
+
prettyPrint?: boolean;
|
|
2119
|
+
/** 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. */
|
|
2120
|
+
quotaUser?: string;
|
|
2121
|
+
/** Specifies which fields to update. If this list is empty, then no state will be updated. Note that the fields `name`, `projectId`, and `projectNumber` are all immutable. */
|
|
2122
|
+
updateMask?: string;
|
|
2123
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2124
|
+
upload_protocol?: string;
|
|
2125
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2126
|
+
uploadType?: string;
|
|
2127
|
+
},
|
|
2128
|
+
body: FirebaseProject): Request<FirebaseProject>;
|
|
2129
|
+
/**
|
|
2130
|
+
* Unlinks the specified FirebaseProject from its Google Analytics account. This call removes the association of the specified `FirebaseProject` with its current Google Analytics
|
|
2131
|
+
* property. However, this call does not delete the Google Analytics resources, such as the Google Analytics property or any data streams. These resources may be re-associated later to
|
|
2132
|
+
* the `FirebaseProject` by calling [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) and specifying the same `analyticsPropertyId`. For Android Apps and iOS Apps, this
|
|
2133
|
+
* call re-links data streams with their corresponding apps. However, for Web Apps, this call provisions a *new* data stream for each Web App. To call `RemoveAnalytics`, a project
|
|
2134
|
+
* member must be an Owner for the `FirebaseProject`.
|
|
2135
|
+
*/
|
|
2136
|
+
removeAnalytics(request: {
|
|
2137
|
+
/** V1 error format. */
|
|
2138
|
+
"$.xgafv"?: string;
|
|
2139
|
+
/** OAuth access token. */
|
|
2140
|
+
access_token?: string;
|
|
2141
|
+
/** Data format for response. */
|
|
2142
|
+
alt?: string;
|
|
2143
|
+
/** JSONP */
|
|
2144
|
+
callback?: string;
|
|
2145
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2146
|
+
fields?: string;
|
|
2147
|
+
/** 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. */
|
|
2148
|
+
key?: string;
|
|
2149
|
+
/** OAuth 2.0 token for the current user. */
|
|
2150
|
+
oauth_token?: string;
|
|
2151
|
+
/**
|
|
2152
|
+
* The resource name of the FirebaseProject to unlink from its Google Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject`
|
|
2153
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
2154
|
+
*/
|
|
2155
|
+
parent: string;
|
|
2156
|
+
/** Returns response with indentations and line breaks. */
|
|
2157
|
+
prettyPrint?: boolean;
|
|
2158
|
+
/** 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. */
|
|
2159
|
+
quotaUser?: string;
|
|
2160
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2161
|
+
upload_protocol?: string;
|
|
2162
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2163
|
+
uploadType?: string;
|
|
2164
|
+
/** Request body */
|
|
2165
|
+
resource: RemoveAnalyticsRequest;
|
|
2166
|
+
}): Request<{}>;
|
|
2167
|
+
removeAnalytics(request: {
|
|
2168
|
+
/** V1 error format. */
|
|
2169
|
+
"$.xgafv"?: string;
|
|
2170
|
+
/** OAuth access token. */
|
|
2171
|
+
access_token?: string;
|
|
2172
|
+
/** Data format for response. */
|
|
2173
|
+
alt?: string;
|
|
2174
|
+
/** JSONP */
|
|
2175
|
+
callback?: string;
|
|
2176
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2177
|
+
fields?: string;
|
|
2178
|
+
/** 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. */
|
|
2179
|
+
key?: string;
|
|
2180
|
+
/** OAuth 2.0 token for the current user. */
|
|
2181
|
+
oauth_token?: string;
|
|
2182
|
+
/**
|
|
2183
|
+
* The resource name of the FirebaseProject to unlink from its Google Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject`
|
|
2184
|
+
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
2185
|
+
*/
|
|
2186
|
+
parent: string;
|
|
2187
|
+
/** Returns response with indentations and line breaks. */
|
|
2188
|
+
prettyPrint?: boolean;
|
|
2189
|
+
/** 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. */
|
|
2190
|
+
quotaUser?: string;
|
|
2191
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2192
|
+
upload_protocol?: string;
|
|
2193
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2194
|
+
uploadType?: string;
|
|
2195
|
+
},
|
|
2196
|
+
body: RemoveAnalyticsRequest): Request<{}>;
|
|
2197
|
+
/**
|
|
2198
|
+
* Lists all available Apps for the specified FirebaseProject. This is a convenience method. Typically, interaction with an App should be done using the platform-specific service, but
|
|
2199
|
+
* some tool use-cases require a summary of all known Apps (such as for App selector interfaces).
|
|
2200
|
+
*/
|
|
2201
|
+
searchApps(request?: {
|
|
2202
|
+
/** V1 error format. */
|
|
2203
|
+
"$.xgafv"?: string;
|
|
2204
|
+
/** OAuth access token. */
|
|
2205
|
+
access_token?: string;
|
|
2206
|
+
/** Data format for response. */
|
|
2207
|
+
alt?: string;
|
|
2208
|
+
/** JSONP */
|
|
2209
|
+
callback?: string;
|
|
2210
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2211
|
+
fields?: string;
|
|
2212
|
+
/**
|
|
2213
|
+
* A query string compatible with Google's [AIP-160](https://google.aip.dev/160) standard. Use any of the following fields in a query: *
|
|
2214
|
+
* [`app_id`](../projects.apps#FirebaseAppInfo.FIELDS.app_id) * [`namespace`](../projects.apps#FirebaseAppInfo.FIELDS.namespace) *
|
|
2215
|
+
* [`platform`](../projects.apps#FirebaseAppInfo.FIELDS.platform) We also support the following "virtual" fields (fields which are not actually part of the returned resource
|
|
2216
|
+
* object, but can be queried as if they are pre-populated with specific values): * `sha1_hash` or `sha1_hashes`: This field is considered to be a repeated `string` field,
|
|
2217
|
+
* populated with the list of all SHA-1 certificate fingerprints registered with the app. This list is empty if the app is not an Android app. * `sha256_hash` or `sha256_hashes`:
|
|
2218
|
+
* This field is considered to be a repeated `string` field, populated with the list of all SHA-256 certificate fingerprints registered with the app. This list is empty if the app
|
|
2219
|
+
* is not an Android app. * `app_store_id`: This field is considered to be a singular `string` field, populated with the Apple App Store ID registered with the app. This field is
|
|
2220
|
+
* empty if the app is not an iOS app. * `team_id`: This field is considered to be a singular `string` field, populated with the Apple team ID registered with the app. This field
|
|
2221
|
+
* is empty if the app is not an iOS app.
|
|
2222
|
+
*/
|
|
2223
|
+
filter?: string;
|
|
2224
|
+
/** 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. */
|
|
2225
|
+
key?: string;
|
|
2226
|
+
/** OAuth 2.0 token for the current user. */
|
|
2227
|
+
oauth_token?: string;
|
|
2228
|
+
/**
|
|
2229
|
+
* The maximum number of Apps to return in the response. The server may return fewer than this value at its discretion. If no value is specified (or too large a value is
|
|
2230
|
+
* specified), then the server will impose its own limit. This value cannot be negative.
|
|
2231
|
+
*/
|
|
2232
|
+
pageSize?: number;
|
|
2233
|
+
/** Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to resume listing. */
|
|
2234
|
+
pageToken?: string;
|
|
2235
|
+
/**
|
|
2236
|
+
* The parent FirebaseProject for which to list Apps, in the format: projects/ PROJECT_IDENTIFIER Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name)
|
|
2237
|
+
* field for details about PROJECT_IDENTIFIER values.
|
|
2238
|
+
*/
|
|
2239
|
+
parent: string;
|
|
2240
|
+
/** Returns response with indentations and line breaks. */
|
|
2241
|
+
prettyPrint?: boolean;
|
|
2242
|
+
/** 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. */
|
|
2243
|
+
quotaUser?: string;
|
|
2244
|
+
/** Controls whether Apps in the DELETED state should be returned. Defaults to false. */
|
|
2245
|
+
showDeleted?: boolean;
|
|
2246
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2247
|
+
upload_protocol?: string;
|
|
2248
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2249
|
+
uploadType?: string;
|
|
2250
|
+
}): Request<SearchFirebaseAppsResponse>;
|
|
2251
|
+
androidApps: AndroidAppsResource;
|
|
2252
|
+
availableLocations: AvailableLocationsResource;
|
|
2253
|
+
defaultLocation: DefaultLocationResource;
|
|
2254
|
+
iosApps: IosAppsResource;
|
|
2255
|
+
webApps: WebAppsResource;
|
|
2256
|
+
}
|
|
2257
|
+
|
|
2258
|
+
const availableProjects: AvailableProjectsResource;
|
|
2259
|
+
|
|
2260
|
+
const operations: OperationsResource;
|
|
2261
|
+
|
|
2262
|
+
const projects: ProjectsResource;
|
|
2263
|
+
}
|
|
2264
|
+
}
|