googleapis
Version:
Google APIs Client Library for Node.js
843 lines • 96.1 kB
TypeScript
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace firebase_v1beta1 {
interface Options extends GlobalOptions {
version: 'v1beta1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Firebase Management API
*
* The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps.
*
* @example
* const {google} = require('googleapis');
* const firebase = google.firebase('v1beta1');
*
* @namespace firebase
* @type {Function}
* @version v1beta1
* @variation v1beta1
* @param {object=} options Options for Firebase
*/
class Firebase {
context: APIRequestContext;
availableProjects: Resource$Availableprojects;
operations: Resource$Operations;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* All fields are required.
*/
interface Schema$AddFirebaseRequest {
/**
* Deprecated. Instead, to set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project. <br> <br>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).
*/
locationId?: string;
/**
* The region code (CLDR) that the account will use for Firebase Analytics data. <br>For example: US, GB, or DE <br> <br>In Java, use `com.google.i18n.identifiers.RegionCode`.
*/
regionCode?: string;
/**
* The time zone that the account will use for Firebase Analytics data. <br>For example: America/Los_Angeles or Africa/Abidjan
*/
timeZone?: string;
}
interface Schema$AdminSdkConfig {
/**
* The default Firebase Realtime Database URL.
*/
databaseURL?: string;
/**
* 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). <br> <br>This field is omitted if the default GCP resource location has not been finalized yet. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project.
*/
locationId?: string;
/**
* Immutable. The globally unique, user-assigned project ID of the parent Project.
*/
projectId?: string;
/**
* The default Cloud Storage for Firebase storage bucket name.
*/
storageBucket?: string;
}
/**
* Details of a Firebase App for Android.
*/
interface Schema$AndroidApp {
/**
* Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified.
*/
appId?: string;
/**
* The user-assigned display name of the App.
*/
displayName?: string;
/**
* The fully qualified resource name of the App, in the format: <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>
*/
name?: string;
/**
* The canonical package name of the Android App as would appear in the Google Play Developer Console.
*/
packageName?: string;
/**
* The globally unique, user-assigned ID of the parent Project for the App.
*/
projectId?: string;
}
/**
* Configuration metadata of a single Firebase App for Android.
*/
interface Schema$AndroidAppConfig {
/**
* The contents of the JSON configuration file.
*/
configFileContents?: string;
/**
* The filename that the configuration artifact is typically saved as. <br>For example: `google-services.json`
*/
configFilename?: string;
}
/**
* The default resources associated with a `FirebaseProject`.
*/
interface Schema$DefaultResources {
/**
* The default Firebase Hosting site name, in the format: <br><code><var>projectId</var></code> <br>Though rare, your `projectId` might already be used as the name for an existing Hosting site in 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 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: <br><code>myproject123-a5c16</code>
*/
hostingSite?: string;
/**
* 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). <br> <br>This field is omitted if the default GCP resource location has not been finalized yet. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project.
*/
locationId?: string;
/**
* The default Firebase Realtime Database instance name, in the format: <br><code><var>projectId</var></code> <br>Though rare, your `projectId` might already be used as the name for an existing Realtime 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 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 instance name might be: <br><code>myproject123-a5c16</code>
*/
realtimeDatabaseInstance?: string;
/**
* The default Cloud Storage for Firebase storage bucket, in the format: <br><code><var>projectId</var>.appspot.com</code>
*/
storageBucket?: string;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
interface Schema$Empty {
}
interface Schema$FinalizeDefaultLocationRequest {
/**
* The ID of the default GCP resource location for the Project. The location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations).
*/
locationId?: string;
}
/**
* A high-level summary of an App.
*/
interface Schema$FirebaseAppInfo {
/**
* Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified.
*/
appId?: string;
/**
* The user-assigned display name of the Firebase App.
*/
displayName?: string;
/**
* The fully qualified resource name of the Firebase App, in the format: <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code> or <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var> </code>
*/
name?: string;
/**
* The platform of the Firebase App.
*/
platform?: string;
}
/**
* A `FirebaseProject` is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets) and other Firebase and Google Cloud Platform (GCP) resources. <br> <br>You can create a new `FirebaseProject` in the [Firebase console](https://console.firebase.google.com/), or you can add Firebase resources to an existing [GCP `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects) by calling AddFirebase. <br> <br>A `FirebaseProject` is actually also a GCP `Project`, so a `FirebaseProject` uses underlying GCP identifiers (most importantly, `projectId`) as its own for easy interop with GCP APIs.
*/
interface Schema$FirebaseProject {
/**
* The user-assigned display name of the Project.
*/
displayName?: string;
/**
* The fully qualified resource name of the Project, in the format: <br><code>projects/<var>projectId</var></code>
*/
name?: string;
/**
* Immutable. The globally unique, user-assigned ID of the Project.
*/
projectId?: string;
/**
* The globally unique, Google-assigned identifier of the Project.
*/
projectNumber?: string;
/**
* The default Firebase resources associated with the Project.
*/
resources?: Schema$DefaultResources;
}
/**
* Details of a Firebase App for iOS.
*/
interface Schema$IosApp {
/**
* Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified.
*/
appId?: string;
/**
* The automatically generated Apple ID assigned to the App by Apple in the iOS App Store.
*/
appStoreId?: string;
/**
* The canonical bundle ID of the iOS App as it would appear in the iOS AppStore.
*/
bundleId?: string;
/**
* The user-assigned display name of the App.
*/
displayName?: string;
/**
* The fully qualified resource name of the App, in the format: <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
*/
name?: string;
/**
* The globally unique, user-assigned ID of the parent Project for the App.
*/
projectId?: string;
}
/**
* Configuration metadata of a single Firebase App for iOS.
*/
interface Schema$IosAppConfig {
/**
* The content of the XML configuration file.
*/
configFileContents?: string;
/**
* The filename that the configuration artifact is typically saved as. <br>For example: `GoogleService-Info.plist`
*/
configFilename?: string;
}
interface Schema$ListAndroidAppsResponse {
/**
* List of each AndroidApp that is in the parent Firebase Project.
*/
apps?: Schema$AndroidApp[];
/**
* 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. <br> <br>This token can be used in a subsequent call to `ListAndroidApps` to find the next group of Apps. <br> <br>Page tokens are short-lived and should not be persisted.
*/
nextPageToken?: string;
}
interface Schema$ListAvailableLocationsResponse {
/**
* One page of results from a call to `ListAvailableLocations`.
*/
locations?: Schema$Location[];
/**
* 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 locations have been listed. <br> <br>This token can be used in a subsequent call to `ListAvailableLocations` to find more locations. <br> <br>Page tokens are short-lived and should not be persisted.
*/
nextPageToken?: string;
}
interface Schema$ListAvailableProjectsResponse {
/**
* 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. <br> <br>This token can be used in a subsequent calls to `ListAvailableProjects` to find the next group of GCP `Projects`. <br> <br>Page tokens are short-lived and should not be persisted.
*/
nextPageToken?: string;
/**
* The list of GCP `Projects` which can have Firebase resources added to them.
*/
projectInfo?: Schema$ProjectInfo[];
}
interface Schema$ListFirebaseProjectsResponse {
/**
* 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. <br> <br>This token can be used in a subsequent calls to `ListFirebaseProjects` to find the next group of Projects. <br> <br>Page tokens are short-lived and should not be persisted.
*/
nextPageToken?: string;
/**
* One page of the list of Projects that are accessible to the caller.
*/
results?: Schema$FirebaseProject[];
}
interface Schema$ListIosAppsResponse {
/**
* List of each IosApp that is in the parent Firebase Project.
*/
apps?: Schema$IosApp[];
/**
* 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. <br> <br>This token can be used in a subsequent call to `ListIosApps` to find the next group of Apps. <br> <br>Page tokens are short-lived and should not be persisted.
*/
nextPageToken?: string;
}
interface Schema$ListShaCertificatesResponse {
/**
* The list of SHA certificates associated with the App.
*/
certificates?: Schema$ShaCertificate[];
}
interface Schema$ListWebAppsResponse {
/**
* List of each WebApp that is in the parent Firebase Project.
*/
apps?: Schema$WebApp[];
/**
* 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. <br> <br>This token can be used in a subsequent call to `ListWebApps` to find the next group of Apps. <br> <br>Page tokens are short-lived and should not be persisted.
*/
nextPageToken?: string;
}
/**
* A GCP resource location that can be selected for a Project.
*/
interface Schema$Location {
/**
* The ID of the default GCP resource location. It must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations).
*/
locationId?: string;
}
/**
* This is proto2's version of MessageSet.
*/
interface Schema$MessageSet {
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
interface Schema$Operation {
/**
* 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.
*/
done?: boolean;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* 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 metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
};
/**
* 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 with `operations/{unique_id}`.
*/
name?: string;
/**
* 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 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 original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
};
}
/**
* A reference to a Google Cloud Platform (GCP) `Project`.
*/
interface Schema$ProjectInfo {
/**
* The user-assigned display name of the GCP `Project`, for example: <code>My App</code>
*/
displayName?: string;
/**
* 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). <br> <br> Not all 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 your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project.
*/
locationId?: string;
/**
* The resource name of the GCP `Project` to which Firebase resources can be added, in the format: <br><code>projects/<var>projectId</var></code>
*/
project?: string;
}
interface Schema$SearchFirebaseAppsResponse {
/**
* One page of results from a call to `SearchFirebaseApps`.
*/
apps?: Schema$FirebaseAppInfo[];
/**
* If the result list is too large to fit in a single response, then a token is returned. <br> <br>This token can be used in a subsequent calls to `SearchFirebaseApps` to find the next group of Apps. <br>If the string is empty, then this response is the last page of results. <br>Page tokens are short-lived and should not be persisted.
*/
nextPageToken?: string;
}
/**
* A SHA-1 or SHA-256 certificate associated with the AndroidApp.
*/
interface Schema$ShaCertificate {
/**
* The SHA certificate type.
*/
certType?: string;
/**
* The fully qualified resource name of the `sha-key`, in the format: <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var>/sha/<var>shaId</var></code>
*/
name?: string;
/**
* The certificate hash for the App.
*/
shaHash?: string;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}>;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
/**
* Wire-format for a Status object
*/
interface Schema$StatusProto {
/**
* The canonical error code (see codes.proto) that most closely corresponds to this status. May be missing.
*/
canonicalCode?: number;
/**
* 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
*/
code?: number;
/**
* Detail message
*/
message?: string;
/**
* message_set associates an arbitrary proto message with the status.
*/
messageSet?: Schema$MessageSet;
/**
* DEPRECATED. This field was deprecated in 2011 with cl/20297133. Java support for the field was moved to a proto1 backward compatibility class in April 2017 with cl/142615857 and cl/154123203. There was never support for this field in Go; if set Go will ignore it. C++ stopped setting StatusProto::payload in October 2015 with cl/106347055, and stopped reading the field in October 2017 with cl/173324114. In general, newly written code should use only "message_set". If you need to maintain backward compatibility with code written before 3/25/2011, do the following: - During the transition period, either (1) set both "payload" and "message_set", or (2) write the consumer of StatusProto so that it can forge a MessageSet object from "payload" if "message_set" is missing. The C++ util::Status implementation does (2). - Once all the consumers are converted to accept "message_set", then remove the use of "payload" on the producer side.
*/
payload?: Schema$TypedMessage;
/**
* The following are usually only present when code != 0 Space to which this status belongs
*/
space?: string;
}
/**
* Message that groups a protocol type_id (as defined by MessageSet), with an encoded message of that type. Its use is similar to MessageSet, except it represents a single (type, encoded message) instead of a set. To fill for known protocol type: MyProtocolMsg proto; TypedMessage typed_msg; typed_msg.set_type_id(MyProtocolMsg::MESSAGE_TYPE_ID); proto.AppendToCord(typed_msg.mutable_message()); To fill for unknown protocol type: ProtocolMessage proto; TypedMessage typed_msg; typed_msg.set_type_id(proto.GetMapper()->type_id()); proto.AppendToCord(typed_msg.mutable_message());
*/
interface Schema$TypedMessage {
/**
* Message bytes.
*/
message?: string;
/**
* Identifier for the type.
*/
typeId?: number;
}
/**
* Details of a Firebase App for the web.
*/
interface Schema$WebApp {
/**
* Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified.
*/
appId?: string;
/**
* The fully qualified URLs where the App is hosted.
*/
appUrls?: string[];
/**
* The user-assigned display name of the App.
*/
displayName?: string;
/**
* The fully qualified resource name of the App, for example: <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code>
*/
name?: string;
/**
* The globally unique, user-assigned ID of the parent Project for the App.
*/
projectId?: string;
}
/**
* Configuration metadata of a single Firebase App for the web.
*/
interface Schema$WebAppConfig {
/**
* The API key associated with the web App.
*/
apiKey?: string;
/**
* Immutable. The globally unique, Firebase-assigned identifier of the App.
*/
appId?: string;
/**
* The domain Firebase Auth configures for OAuth redirects, in the format: <br><code><var>projectId</var>.firebaseapp.com</code>
*/
authDomain?: string;
/**
* The default Firebase Realtime Database URL.
*/
databaseURL?: string;
/**
* 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). <br> <br>This field is omitted if the default GCP resource location has not been finalized yet. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project.
*/
locationId?: string;
/**
* The sender ID for use with Firebase Cloud Messaging.
*/
messagingSenderId?: string;
/**
* Immutable. The globally unique, user-assigned project ID of the parent Project for the App.
*/
projectId?: string;
/**
* The default Cloud Storage for Firebase storage bucket name.
*/
storageBucket?: string;
}
class Resource$Availableprojects {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* firebase.availableProjects.list
* @desc Returns a list of [Google Cloud Platform (GCP) `Projects`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects) that are available to have Firebase resources added to them. <br> <br>A GCP `Project` will only be returned if: <ol> <li><p>The caller has sufficient [Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase.</p></li> <li><p>The GCP `Project` is not already a FirebaseProject.</p></li> <li><p>The GCP `Project` is not in an Organization which has policies that prevent Firebase resources from being added.</p></li> </ol>
* @alias firebase.availableProjects.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of GCP `Projects` to return in the response. <br> <br>The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. <br> <br>This value cannot be negative.
* @param {string=} params.pageToken Token returned from a previous call to `ListAvailableProjects` indicating where in the set of GCP `Projects` to resume listing.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Availableprojects$List, options?: MethodOptions): GaxiosPromise<Schema$ListAvailableProjectsResponse>;
list(params: Params$Resource$Availableprojects$List, options: MethodOptions | BodyResponseCallback<Schema$ListAvailableProjectsResponse>, callback: BodyResponseCallback<Schema$ListAvailableProjectsResponse>): void;
list(params: Params$Resource$Availableprojects$List, callback: BodyResponseCallback<Schema$ListAvailableProjectsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAvailableProjectsResponse>): void;
}
interface Params$Resource$Availableprojects$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of GCP `Projects` to return in the response. <br> <br>The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. <br> <br>This value cannot be negative.
*/
pageSize?: number;
/**
* Token returned from a previous call to `ListAvailableProjects` indicating where in the set of GCP `Projects` to resume listing.
*/
pageToken?: string;
}
class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* firebase.operations.get
* @desc 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.
* @alias firebase.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
class Resource$Projects {
context: APIRequestContext;
androidApps: Resource$Projects$Androidapps;
availableLocations: Resource$Projects$Availablelocations;
defaultLocation: Resource$Projects$Defaultlocation;
iosApps: Resource$Projects$Iosapps;
webApps: Resource$Projects$Webapps;
constructor(context: APIRequestContext);
/**
* firebase.projects.addFirebase
* @desc Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects). <br> <br>Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` uses underlying GCP identifiers (most importantly, the `projectId`) as its own for easy interop with GCP APIs. <br> <br>The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to a FirebaseProject; if the `Operation` failed, its [`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 DeleteOperation. <br> <br>This method does not modify any billing account information on the underlying GCP `Project`. <br> <br>All fields listed in the [request body](#request-body) are required. <br> <br>To call `AddFirebase`, a member must be an Editor or Owner for the existing GCP `Project`. Service accounts cannot call `AddFirebase`.
* @alias firebase.projects.addFirebase
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.project The resource name of the GCP `Project` to which Firebase resources will be added, in the format: <br><code>projects/<var>projectId</var></code> After calling `AddFirebase`, the [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id) of the GCP `Project` is also the `projectId` of the FirebaseProject.
* @param {().AddFirebaseRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
addFirebase(params?: Params$Resource$Projects$Addfirebase, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
addFirebase(params: Params$Resource$Projects$Addfirebase, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
addFirebase(params: Params$Resource$Projects$Addfirebase, callback: BodyResponseCallback<Schema$Operation>): void;
addFirebase(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* firebase.projects.get
* @desc Gets the FirebaseProject identified by the specified resource name.
* @alias firebase.projects.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The fully qualified resource name of the Project, in the format: <br><code>projects/<var>projectId</var></code>
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Get, options?: MethodOptions): GaxiosPromise<Schema$FirebaseProject>;
get(params: Params$Resource$Projects$Get, options: MethodOptions | BodyResponseCallback<Schema$FirebaseProject>, callback: BodyResponseCallback<Schema$FirebaseProject>): void;
get(params: Params$Resource$Projects$Get, callback: BodyResponseCallback<Schema$FirebaseProject>): void;
get(callback: BodyResponseCallback<Schema$FirebaseProject>): void;
/**
* firebase.projects.getAdminSdkConfig
* @desc Gets the configuration artifact used by servers to simplify initialization. <br> <br>Typically, this configuration is used with the Firebase Admin SDK [initializeApp](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) command.
* @alias firebase.projects.getAdminSdkConfig
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The fully qualified resource name of the Project, in the format: <br><code>projects/<var>projectId</var>/adminSdkConfig</code>
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getAdminSdkConfig(params?: Params$Resource$Projects$Getadminsdkconfig, options?: MethodOptions): GaxiosPromise<Schema$AdminSdkConfig>;
getAdminSdkConfig(params: Params$Resource$Projects$Getadminsdkconfig, options: MethodOptions | BodyResponseCallback<Schema$AdminSdkConfig>, callback: BodyResponseCallback<Schema$AdminSdkConfig>): void;
getAdminSdkConfig(params: Params$Resource$Projects$Getadminsdkconfig, callback: BodyResponseCallback<Schema$AdminSdkConfig>): void;
getAdminSdkConfig(callback: BodyResponseCallback<Schema$AdminSdkConfig>): void;
/**
* firebase.projects.list
* @desc Lists each FirebaseProject accessible to the caller. <br> <br>The elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests are made with a `pageToken`. <br> <br>This method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might not be reflected in the set of Projects. The list will include only ACTIVE Projects. <br> <br>Use GetFirebaseProject for consistent reads as well as for additional Project details.
* @alias firebase.projects.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of Projects to return in the response. <br> <br>The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. <br> <br>This value cannot be negative.
* @param {string=} params.pageToken Token returned from a previous call to `ListFirebaseProjects` indicating where in the set of Projects to resume listing.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$List, options?: MethodOptions): GaxiosPromise<Schema$ListFirebaseProjectsResponse>;
list(params: Params$Resource$Projects$List, options: MethodOptions | BodyResponseCallback<Schema$ListFirebaseProjectsResponse>, callback: BodyResponseCallback<Schema$ListFirebaseProjectsResponse>): void;
list(params: Params$Resource$Projects$List, callback: BodyResponseCallback<Schema$ListFirebaseProjectsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListFirebaseProjectsResponse>): void;
/**
* firebase.projects.patch
* @desc Updates the attributes of the FirebaseProject identified by the specified resource name. <br> <br>All [query parameters](#query-parameters) are required.
* @alias firebase.projects.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The fully qualified resource name of the Project, in the format: <br><code>projects/<var>projectId</var></code>
* @param {string=} params.updateMask Specifies which fields to update. <br> <br>If this list is empty, then no state will be updated. <br>Note that the fields `name`, `project_id`, and `project_number` are all immutable.
* @param {().FirebaseProject} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Patch, options?: MethodOptions): GaxiosPromise<Schema$FirebaseProject>;
patch(params: Params$Resource$Projects$Patch, options: MethodOptions | BodyResponseCallback<Schema$FirebaseProject>, callback: BodyResponseCallback<Schema$FirebaseProject>): void;
patch(params: Params$Resource$Projects$Patch, callback: BodyResponseCallback<Schema$FirebaseProject>): void;
patch(callback: BodyResponseCallback<Schema$FirebaseProject>): void;
/**
* firebase.projects.searchApps
* @desc A convenience method that lists all available Apps for the specified FirebaseProject. <br> <br>Typically, interaction with an App should be done using the platform-specific service, but some tool use-cases require a summary of all known Apps (such as for App selector interfaces).
* @alias firebase.projects.searchApps
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of Apps to return in the response. <br> <br>The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. <br> <br>This value cannot be negative.
* @param {string=} params.pageToken Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to resume listing.
* @param {string} params.parent The parent Project for which to list Apps, in the format: <br><code>projects/<var>projectId</var></code>
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
searchApps(params?: Params$Resource$Projects$Searchapps, options?: MethodOptions): GaxiosPromise<Schema$SearchFirebaseAppsResponse>;
searchApps(params: Params$Resource$Projects$Searchapps, options: MethodOptions | BodyResponseCallback<Schema$SearchFirebaseAppsResponse>, callback: BodyResponseCallback<Schema$SearchFirebaseAppsResponse>): void;
searchApps(params: Params$Resource$Projects$Searchapps, callback: BodyResponseCallback<Schema$SearchFirebaseAppsResponse>): void;
searchApps(callback: BodyResponseCallback<Schema$SearchFirebaseAppsResponse>): void;
}
interface Params$Resource$Projects$Addfirebase extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the GCP `Project` to which Firebase resources will be added, in the format: <br><code>projects/<var>projectId</var></code> After calling `AddFirebase`, the [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id) of the GCP `Project` is also the `projectId` of the FirebaseProject.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AddFirebaseRequest;
}
interface Params$Resource$Projects$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The fully qualified resource name of the Project, in the format: <br><code>projects/<var>projectId</var></code>
*/
name?: string;
}
interface Params$Resource$Projects$Getadminsdkconfig extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The fully qualified resource name of the Project, in the format: <br><code>projects/<var>projectId</var>/adminSdkConfig</code>
*/
name?: string;
}
interface Params$Resource$Projects$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of Projects to return in the response. <br> <br>The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. <br> <br>This value cannot be negative.
*/
pageSize?: number;
/**
* Token returned from a previous call to `ListFirebaseProjects` indicating where in the set of Projects to resume listing.
*/
pageToken?: string;
}
interface Params$Resource$Projects$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The fully qualified resource name of the Project, in the format: <br><code>projects/<var>projectId</var></code>
*/
name?: string;
/**
* Specifies which fields to update. <br> <br>If this list is empty, then no state will be updated. <br>Note that the fields `name`, `project_id`, and `project_number` are all immutable.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FirebaseProject;
}
interface Params$Resource$Projects$Searchapps extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of Apps to return in the response. <br> <br>The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. <br> <br>This value cannot be negative.
*/
pageSize?: number;
/**
* Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to resume listing.
*/
pageToken?: string;
/**
* The parent Project for which to list Apps, in the format: <br><code>projects/<var>projectId</var></code>
*/
parent?: string;
}
class Resource$Projects$Androidapps {
context: APIRequestContext;
sha: Resource$Projects$Androidapps$Sha;
constructor(context: APIRequestContext);
/**
* firebase.projects.androidApps.create
* @desc Requests that a new AndroidApp be created. <br> <br>The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`.
* @alias firebase.projects.androidApps.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The parent Project for which to list Apps, in the format: <br><code>projects/<var>projectId</var></code>
* @param {().AndroidApp} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Androidapps$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Androidapps$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Androidapps$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* firebase.projects.androidApps.get
* @desc Gets the