@maxim_mazurok/gapi.client.firebase-v1beta1 0.0.20230901 → 0.0.20230907

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://firebase.googleapis.com/$discovery/rest?version=v1beta1
-// Revision: 20230901
+// Revision: 20230907
 
 /// <reference types="gapi.client" />
 
@@ -43,13 +43,12 @@ declare namespace gapi.client {
                 string;
         }
         interface 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). This field
-             * is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call
-             * [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
+             * **DEPRECATED.** _Instead, use product-specific REST APIs to find the location of resources._ 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 is omitted if the default GCP resource location has not been finalized yet. To
+             * set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
              */
             locationId?:
                 string;
@@ -59,7 +58,11 @@ declare namespace gapi.client {
              */
             projectId?:
                 string;
-            /** The default Cloud Storage for Firebase storage bucket name. */
+            /**
+             * **DEPRECATED.** _Instead, find the default Cloud Storage for Firebase bucket using the [list
+             * endpoint](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) within the Cloud Storage for Firebase REST API. Note that the default bucket for
+             * the Project might not yet be provisioned, so the return might not contain a default bucket._ The default Cloud Storage for Firebase storage bucket name.
+             */
             storageBucket?:
                 string;
         }
@@ -153,29 +156,38 @@ declare namespace gapi.client {
         }
         interface DefaultResources {
             /**
-             * 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
-             * 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:
-             * `myproject123-a5c16`
+             * Output only. **DEPRECATED.** _Instead, find the default Firebase Hosting site name using the
+             * [ListSites](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/projects.sites/list) within the Firebase Hosting REST API. Note that the default site for the Project
+             * might not yet be provisioned, so the return might not contain a default site._ 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 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: `myproject123-a5c16`
              */
             hostingSite?:
                 string;
             /**
-             * Output only. 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 is omitted if the default GCP resource location has not been finalized yet. To set a Project's default
-             * GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
+             * Output only. **DEPRECATED.** _Instead, use product-specific REST APIs to find the location of resources._ 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 is omitted if the default GCP resource location has not been finalized
+             * yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
              */
             locationId?:
                 string;
             /**
-             * 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
-             * 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: `myproject123-a5c16`
+             * Output only. **DEPRECATED.** _Instead, find the default Firebase Realtime Database instance name using the [list
+             * endpoint](https://firebase.google.com/docs/reference/rest/database/database-management/rest/v1beta/projects.locations.instances/list) within the Firebase Realtime Database REST API.
+             * Note that the default instance for the Project might not yet be provisioned, so the return might not contain a default instance._ 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 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: `myproject123-a5c16`
              */
             realtimeDatabaseInstance?:
                 string;
-            /** Output only. The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com */
+            /**
+             * Output only. **DEPRECATED.** _Instead, find the default Cloud Storage for Firebase bucket using the [list
+             * endpoint](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) within the Cloud Storage for Firebase REST API. Note that the default bucket for
+             * the Project might not yet be provisioned, so the return might not contain a default bucket._ The default Cloud Storage for Firebase storage bucket, in the format:
+             * PROJECT_ID.appspot.com
+             */
             storageBucket?:
                 string;
         }
@@ -262,7 +274,10 @@ declare namespace gapi.client {
              */
             projectNumber?:
                 string;
-            /** Output only. The default Firebase resources associated with the Project. */
+            /**
+             * Output only. **DEPRECATED.** _Auto-provisioning of these resources is changing, so this object no longer reliably provides information about the Project. Instead, retrieve
+             * information about each resource directly from its resource-specific API._ The default Firebase resources associated with the Project.
+             */
             resources?:
                 DefaultResources;
             /** Output only. The lifecycle state of the Project. */
@@ -700,13 +715,17 @@ declare namespace gapi.client {
             /** The domain Firebase Auth configures for OAuth redirects, in the format: PROJECT_ID.firebaseapp.com */
             authDomain?:
                 string;
-            /** The default Firebase Realtime Database URL. */
+            /**
+             * **DEPRECATED.** _Instead, find the default Firebase Realtime Database instance name using the [list
+             * endpoint](https://firebase.google.com/docs/reference/rest/database/database-management/rest/v1beta/projects.locations.instances/list) within the Firebase Realtime Database REST API.
+             * Note that the default instance for the Project might not yet be provisioned, so the return might not contain a default instance._ 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). This field
-             * is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call
-             * [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
+             * **DEPRECATED.** _Instead, use product-specific REST APIs to find the location of resources._ 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 is omitted if the default GCP resource location has not been finalized yet. To
+             * set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
              */
             locationId?:
                 string;
@@ -725,7 +744,11 @@ declare namespace gapi.client {
             /** Immutable. A user-assigned unique identifier for the `FirebaseProject`. */
             projectId?:
                 string;
-            /** The default Cloud Storage for Firebase storage bucket name. */
+            /**
+             * **DEPRECATED.** _Instead, find the default Cloud Storage for Firebase bucket using the [list
+             * endpoint](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) within the Cloud Storage for Firebase REST API. Note that the default bucket for
+             * the Project might not yet be provisioned, so the return might not contain a default bucket._ The default Cloud Storage for Firebase storage bucket name.
+             */
             storageBucket?:
                 string;
         }
@@ -1519,13 +1542,14 @@ declare namespace gapi.client {
         }
         interface AvailableLocationsResource {
             /**
-             * 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
-             * [_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,
-             * 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
-             * 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
-             * 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,
-             * `/v1beta1/{parent=projects/-}/listAvailableLocations`). To call `ListAvailableLocations` with a specified project, a member must be at minimum a Viewer of the Project. Calls without
-             * a specified project do not require any specific project permissions.
+             * **DEPRECATED.** _Instead, use the applicable resource-specific REST API (or associated documentation, as needed) to determine valid locations for each resource used in your
+             * Project._ 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 [_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, 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 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 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, `/v1beta1/{parent=projects/-}/listAvailableLocations`). To call `ListAvailableLocations` with a specified project, a member must be at minimum a Viewer of the Project.
+             * Calls without a specified project do not require any specific project permissions.
              */
             list(request?: {
                 /** V1 error format. */
@@ -1581,7 +1605,8 @@ declare namespace gapi.client {
         }
         interface DefaultLocationResource {
             /**
-             * 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
+             * **DEPRECATED.** _Instead, use the applicable resource-specific REST API to set the location for each resource used in your Project._ 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
              * bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified
              * [`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).
              * 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.firebase-v1beta1",
-  "version": "0.0.20230901",
+  "version": "0.0.20230907",
   "description": "TypeScript typings for Firebase Management API v1beta1",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230901
+// Revision: 20230907
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -252,6 +252,7 @@ gapi.load('client', async () => {
             parent: "Test string",
         });
         /**
+         * **DEPRECATED.** _Instead, use the applicable resource-specific REST API (or associated documentation, as needed) to determine valid locations for each resource used in your Project._
          * 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
          * [_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, 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 possible
@@ -266,7 +267,8 @@ gapi.load('client', async () => {
             parent: "Test string",
         });
         /**
-         * 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
+         * **DEPRECATED.** _Instead, use the applicable resource-specific REST API to set the location for each resource used in your Project._ 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
          * bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified
          * [`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). 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 already be