firebase-admin 9.100.0-alpha.0 → 10.0.2

package/lib/auth/user-import-builder.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2018 Google Inc.
  *
@@ -20,7 +20,7 @@ import { UpdateMultiFactorInfoRequest, MultiFactorUpdateSettings } from './auth-
 export declare type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';
 /**
    * Interface representing the user import options needed for
-   * {@link auth.Auth.importUsers `importUsers()`} method. This is used to
+   * {@link BaseAuth.importUsers} method. This is used to
    * provide the password hashing algorithm information.
    */
 export interface UserImportOptions {
@@ -77,7 +77,7 @@ export interface UserImportOptions {
 }
 /**
  * Interface representing a user to import to Firebase Auth via the
- * {@link auth.Auth.importUsers `importUsers()`} method.
+ * {@link BaseAuth.importUsers} method.
  */
 export interface UserImportRecord {
     /**
@@ -127,7 +127,7 @@ export interface UserImportRecord {
     /**
      * The buffer of bytes representing the user's hashed password.
      * When a user is to be imported with a password hash,
-     * {@link auth.UserImportOptions `UserImportOptions`} are required to be
+     * {@link UserImportOptions} are required to be
      * specified to identify the hashing algorithm used to generate this hash.
      */
     passwordHash?: Buffer;
@@ -192,7 +192,7 @@ export interface UserProviderRequest {
 }
 /**
    * Interface representing the response from the
-   * {@link auth.Auth.importUsers `importUsers()`} method for batch
+   * {@link BaseAuth.importUsers} method for batch
    * importing users to Firebase Auth.
    */
 export interface UserImportResult {
@@ -262,8 +262,8 @@ export interface UploadAccountRequest extends UploadAccountOptions {
 export declare type ValidatorFunction = (data: UploadAccountUser) => void;
 /**
  * Converts a client format second factor object to server format.
- * @param multiFactorInfo The client format second factor.
- * @return The corresponding AuthFactorInfo server request format.
+ * @param multiFactorInfo - The client format second factor.
+ * @returns The corresponding AuthFactorInfo server request format.
  */
 export declare function convertMultiFactorInfoToServerFormat(multiFactorInfo: UpdateMultiFactorInfoRequest): AuthFactorInfo;
 /**
@@ -286,13 +286,13 @@ export declare class UserImportBuilder {
     constructor(users: UserImportRecord[], options?: UserImportOptions, userRequestValidator?: ValidatorFunction);
     /**
      * Returns the corresponding constructed uploadAccount request.
-     * @return {UploadAccountRequest} The constructed uploadAccount request.
+     * @returns {UploadAccountRequest} The constructed uploadAccount request.
      */
     buildRequest(): UploadAccountRequest;
     /**
      * Populates the UserImportResult using the client side detected errors and the server
      * side returned errors.
-     * @return {UserImportResult} The user import result based on the returned failed
+     * @returns {UserImportResult} The user import result based on the returned failed
      *     uploadAccount response.
      */
     buildResponse(failedUploads: Array<{
@@ -304,7 +304,7 @@ export declare class UserImportBuilder {
      * Throws an error whenever an invalid or missing options is detected.
      * @param {UserImportOptions} options The UserImportOptions.
      * @param {boolean} requiresHashOptions Whether to require hash options.
-     * @return {UploadAccountOptions} The populated UploadAccount options.
+     * @returns {UploadAccountOptions} The populated UploadAccount options.
      */
     private populateOptions;
     /**
@@ -315,7 +315,7 @@ export declare class UserImportBuilder {
      * @param {UserImportRecord[]} users The UserImportRecords to convert to UnploadAccountUser
      *     objects.
      * @param {ValidatorFunction=} userValidator The user validator function.
-     * @return {UploadAccountUser[]} The populated uploadAccount users.
+     * @returns {UploadAccountUser[]} The populated uploadAccount users.
      */
     private populateUsers;
 }

package/lib/auth/user-import-builder.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.
@@ -23,8 +23,8 @@ var validator = require("../utils/validator");
 var error_1 = require("../utils/error");
 /**
  * Converts a client format second factor object to server format.
- * @param multiFactorInfo The client format second factor.
- * @return The corresponding AuthFactorInfo server request format.
+ * @param multiFactorInfo - The client format second factor.
+ * @returns The corresponding AuthFactorInfo server request format.
  */
 function convertMultiFactorInfoToServerFormat(multiFactorInfo) {
     var enrolledAt;
@@ -67,7 +67,7 @@ function isPhoneFactor(multiFactorInfo) {
 /**
  * @param {any} obj The object to check for number field within.
  * @param {string} key The entry key.
- * @return {number} The corresponding number if available. Otherwise, NaN.
+ * @returns {number} The corresponding number if available. Otherwise, NaN.
  */
 function getNumberField(obj, key) {
     if (typeof obj[key] !== 'undefined' && obj[key] !== null) {
@@ -80,7 +80,7 @@ function getNumberField(obj, key) {
  * fields are provided.
  * @param {UserImportRecord} user The UserImportRecord to conver to UploadAccountUser.
  * @param {ValidatorFunction=} userValidator The user validator function.
- * @return {UploadAccountUser} The corresponding UploadAccountUser to return.
+ * @returns {UploadAccountUser} The corresponding UploadAccountUser to return.
  */
 function populateUploadAccountUser(user, userValidator) {
     var result = {
@@ -176,7 +176,7 @@ var UserImportBuilder = /** @class */ (function () {
     }
     /**
      * Returns the corresponding constructed uploadAccount request.
-     * @return {UploadAccountRequest} The constructed uploadAccount request.
+     * @returns {UploadAccountRequest} The constructed uploadAccount request.
      */
     UserImportBuilder.prototype.buildRequest = function () {
         var users = this.validatedUsers.map(function (user) {
@@ -187,7 +187,7 @@ var UserImportBuilder = /** @class */ (function () {
     /**
      * Populates the UserImportResult using the client side detected errors and the server
      * side returned errors.
-     * @return {UserImportResult} The user import result based on the returned failed
+     * @returns {UserImportResult} The user import result based on the returned failed
      *     uploadAccount response.
      */
     UserImportBuilder.prototype.buildResponse = function (failedUploads) {
@@ -219,7 +219,7 @@ var UserImportBuilder = /** @class */ (function () {
      * Throws an error whenever an invalid or missing options is detected.
      * @param {UserImportOptions} options The UserImportOptions.
      * @param {boolean} requiresHashOptions Whether to require hash options.
-     * @return {UploadAccountOptions} The populated UploadAccount options.
+     * @returns {UploadAccountOptions} The populated UploadAccount options.
      */
     UserImportBuilder.prototype.populateOptions = function (options, requiresHashOptions) {
         var populatedOptions;
@@ -356,7 +356,7 @@ var UserImportBuilder = /** @class */ (function () {
      * @param {UserImportRecord[]} users The UserImportRecords to convert to UnploadAccountUser
      *     objects.
      * @param {ValidatorFunction=} userValidator The user validator function.
-     * @return {UploadAccountUser[]} The populated uploadAccount users.
+     * @returns {UploadAccountUser[]} The populated uploadAccount users.
      */
     UserImportBuilder.prototype.populateUsers = function (users, userValidator) {
         var _this = this;

package/lib/auth/user-record.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -52,7 +52,7 @@ export interface GetAccountInfoUserResponse {
     [key: string]: any;
 }
 /**
- * Interface representing the common properties of a user enrolled second factor.
+ * Interface representing the common properties of a user-enrolled second factor.
  */
 export declare abstract class MultiFactorInfo {
     /**
@@ -72,18 +72,20 @@ export declare abstract class MultiFactorInfo {
      */
     readonly enrollmentTime?: string;
     /**
-     * @return A JSON-serializable representation of this object.
+     * Returns a JSON-serializable representation of this object.
+     *
+     * @returns A JSON-serializable representation of this object.
      */
     toJSON(): object;
     /**
      * Initializes the MultiFactorInfo object using the provided server response.
      *
-     * @param response The server side response.
+     * @param response - The server side response.
      */
     private initFromServerResponse;
 }
 /**
- * Interface representing a phone specific user enrolled second factor.
+ * Interface representing a phone specific user-enrolled second factor.
  */
 export declare class PhoneMultiFactorInfo extends MultiFactorInfo {
     /**
@@ -105,7 +107,9 @@ export declare class MultiFactorSettings {
      */
     enrolledFactors: MultiFactorInfo[];
     /**
-     * @return A JSON-serializable representation of this multi-factor object.
+     * Returns a JSON-serializable representation of this multi-factor object.
+     *
+     * @returns A JSON-serializable representation of this multi-factor object.
      */
     toJSON(): object;
 }
@@ -128,7 +132,9 @@ export declare class UserMetadata {
      */
     readonly lastRefreshTime?: string | null;
     /**
-     * @return A JSON-serializable representation of this object.
+     * Returns a JSON-serializable representation of this object.
+     *
+     * @returns A JSON-serializable representation of this object.
      */
     toJSON(): object;
 }
@@ -162,7 +168,9 @@ export declare class UserInfo {
      */
     readonly phoneNumber: string;
     /**
-     * @return A JSON-serializable representation of this object.
+     * Returns a JSON-serializable representation of this object.
+     *
+     * @returns A JSON-serializable representation of this object.
      */
     toJSON(): object;
 }
@@ -213,7 +221,7 @@ export declare class UserRecord {
      * when uploading this user, as is typical when migrating from another Auth
      * system, this will be an empty string. If no password is set, this is
      * null. This is only available when the user is obtained from
-     * {@link auth.Auth.listUsers `listUsers()`}.
+     * {@link BaseAuth.listUsers}.
      */
     readonly passwordHash?: string;
     /**
@@ -221,15 +229,13 @@ export declare class UserRecord {
      * algorithm (SCRYPT) is used. If a different hashing algorithm had been used to
      * upload this user, typical when migrating from another Auth system, this will
      * be an empty string. If no password is set, this is null. This is only
-     * available when the user is obtained from
-     * {@link auth.Auth.listUsers `listUsers()`}.
+     * available when the user is obtained from {@link BaseAuth.listUsers}.
      */
     readonly passwordSalt?: string;
     /**
      * The user's custom claims object if available, typically used to define
      * user roles and propagated to an authenticated user's ID token.
-     * This is set via
-     * {@link auth.Auth.setCustomUserClaims `setCustomUserClaims()`}
+     * This is set via {@link BaseAuth.setCustomUserClaims}
      */
     readonly customClaims?: {
         [key: string]: any;
@@ -241,7 +247,7 @@ export declare class UserRecord {
     /**
      * The date the user's tokens are valid after, formatted as a UTC string.
      * This is updated every time the user's refresh token are revoked either
-     * from the {@link auth.Auth.revokeRefreshTokens `revokeRefreshTokens()`}
+     * from the {@link BaseAuth.revokeRefreshTokens}
      * API or from the Firebase Auth backend on big account changes (password
      * resets, password or email updates, etc).
      */
@@ -251,7 +257,9 @@ export declare class UserRecord {
      */
     readonly multiFactor?: MultiFactorSettings;
     /**
-     * @return A JSON-serializable representation of this object.
+     * Returns a JSON-serializable representation of this object.
+     *
+     * @returns A JSON-serializable representation of this object.
      */
     toJSON(): object;
 }

package/lib/auth/user-record.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license
@@ -42,8 +42,8 @@ var B64_REDACTED = Buffer.from('REDACTED').toString('base64');
 /**
  * Parses a time stamp string or number and returns the corresponding date if valid.
  *
- * @param {any} time The unix timestamp string or number in milliseconds.
- * @return {string} The corresponding date as a UTC string, if valid. Otherwise, null.
+ * @param time - The unix timestamp string or number in milliseconds.
+ * @returns The corresponding date as a UTC string, if valid. Otherwise, null.
  */
 function parseDate(time) {
     try {
@@ -62,13 +62,13 @@ var MultiFactorId;
     MultiFactorId["Phone"] = "phone";
 })(MultiFactorId || (MultiFactorId = {}));
 /**
- * Interface representing the common properties of a user enrolled second factor.
+ * Interface representing the common properties of a user-enrolled second factor.
  */
 var MultiFactorInfo = /** @class */ (function () {
     /**
      * Initializes the MultiFactorInfo object using the server side response.
      *
-     * @param response The server side response.
+     * @param response - The server side response.
      * @constructor
      * @internal
      */
@@ -79,7 +79,7 @@ var MultiFactorInfo = /** @class */ (function () {
      * Initializes the MultiFactorInfo associated subclass using the server side.
      * If no MultiFactorInfo is associated with the response, null is returned.
      *
-     * @param response The server side response.
+     * @param response - The server side response.
      * @internal
      */
     MultiFactorInfo.initMultiFactorInfo = function (response) {
@@ -94,7 +94,9 @@ var MultiFactorInfo = /** @class */ (function () {
         return multiFactorInfo;
     };
     /**
-     * @return A JSON-serializable representation of this object.
+     * Returns a JSON-serializable representation of this object.
+     *
+     * @returns A JSON-serializable representation of this object.
      */
     MultiFactorInfo.prototype.toJSON = function () {
         return {
@@ -107,7 +109,7 @@ var MultiFactorInfo = /** @class */ (function () {
     /**
      * Initializes the MultiFactorInfo object using the provided server response.
      *
-     * @param response The server side response.
+     * @param response - The server side response.
      */
     MultiFactorInfo.prototype.initFromServerResponse = function (response) {
         var factorId = response && this.getFactorId(response);
@@ -132,14 +134,14 @@ var MultiFactorInfo = /** @class */ (function () {
 }());
 exports.MultiFactorInfo = MultiFactorInfo;
 /**
- * Interface representing a phone specific user enrolled second factor.
+ * Interface representing a phone specific user-enrolled second factor.
  */
 var PhoneMultiFactorInfo = /** @class */ (function (_super) {
     __extends(PhoneMultiFactorInfo, _super);
     /**
      * Initializes the PhoneMultiFactorInfo object using the server side response.
      *
-     * @param response The server side response.
+     * @param response - The server side response.
      * @constructor
      * @internal
      */
@@ -159,8 +161,8 @@ var PhoneMultiFactorInfo = /** @class */ (function (_super) {
     /**
      * Returns the factor ID based on the response provided.
      *
-     * @param response The server side response.
-     * @return The multi-factor ID associated with the provided response. If the response is
+     * @param response - The server side response.
+     * @returns The multi-factor ID associated with the provided response. If the response is
      *     not associated with any known multi-factor ID, null is returned.
      *
      * @internal
@@ -178,7 +180,7 @@ var MultiFactorSettings = /** @class */ (function () {
     /**
      * Initializes the MultiFactor object using the server side or JWT format response.
      *
-     * @param response The server side response.
+     * @param response - The server side response.
      * @constructor
      * @internal
      */
@@ -199,7 +201,9 @@ var MultiFactorSettings = /** @class */ (function () {
         utils.addReadonlyGetter(this, 'enrolledFactors', Object.freeze(parsedEnrolledFactors));
     }
     /**
-     * @return A JSON-serializable representation of this multi-factor object.
+     * Returns a JSON-serializable representation of this multi-factor object.
+     *
+     * @returns A JSON-serializable representation of this multi-factor object.
      */
     MultiFactorSettings.prototype.toJSON = function () {
         return {
@@ -214,7 +218,7 @@ exports.MultiFactorSettings = MultiFactorSettings;
  */
 var UserMetadata = /** @class */ (function () {
     /**
-     * @param response The server side response returned from the getAccountInfo
+     * @param response - The server side response returned from the getAccountInfo
      *     endpoint.
      * @constructor
      * @internal
@@ -230,7 +234,9 @@ var UserMetadata = /** @class */ (function () {
         utils.addReadonlyGetter(this, 'lastRefreshTime', lastRefreshAt);
     }
     /**
-     * @return A JSON-serializable representation of this object.
+     * Returns a JSON-serializable representation of this object.
+     *
+     * @returns A JSON-serializable representation of this object.
      */
     UserMetadata.prototype.toJSON = function () {
         return {
@@ -247,7 +253,7 @@ exports.UserMetadata = UserMetadata;
  */
 var UserInfo = /** @class */ (function () {
     /**
-     * @param response The server side response returned from the getAccountInfo
+     * @param response - The server side response returned from the `getAccountInfo`
      *     endpoint.
      * @constructor
      * @internal
@@ -265,7 +271,9 @@ var UserInfo = /** @class */ (function () {
         utils.addReadonlyGetter(this, 'phoneNumber', response.phoneNumber);
     }
     /**
-     * @return A JSON-serializable representation of this object.
+     * Returns a JSON-serializable representation of this object.
+     *
+     * @returns A JSON-serializable representation of this object.
      */
     UserInfo.prototype.toJSON = function () {
         return {
@@ -285,7 +293,7 @@ exports.UserInfo = UserInfo;
  */
 var UserRecord = /** @class */ (function () {
     /**
-     * @param response The server side response returned from the getAccountInfo
+     * @param response - The server side response returned from the getAccountInfo
      *     endpoint.
      * @constructor
      * @internal
@@ -336,7 +344,9 @@ var UserRecord = /** @class */ (function () {
         }
     }
     /**
-     * @return A JSON-serializable representation of this object.
+     * Returns a JSON-serializable representation of this object.
+     *
+     * @returns A JSON-serializable representation of this object.
      */
     UserRecord.prototype.toJSON = function () {
         var json = {

package/lib/credential/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2020 Google Inc.
  *
@@ -22,28 +22,21 @@ export declare namespace credential {
      * with Firebase services.
      *
      * In most cases, you will not need to implement this yourself and can instead
-     * use the default implementations provided by
-     * {@link credential `admin.credential`}.
+     * use the default implementations provided by the `admin.credential` namespace.
      */
     type Credential = TCredential;
     /**
      * Returns a credential created from the
-     * {@link
-     *    https://developers.google.com/identity/protocols/application-default-credentials
-     *    Google Application Default Credentials}
+     * {@link https://developers.google.com/identity/protocols/application-default-credentials |
+     * Google Application Default Credentials}
      * that grants admin access to Firebase services. This credential can be used
-     * in the call to
-     * {@link
-     *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
-     *  `admin.initializeApp()`}.
+     * in the call to {@link firebase-admin.app#initializeApp}.
      *
      * Google Application Default Credentials are available on any Google
      * infrastructure, such as Google App Engine and Google Compute Engine.
      *
      * See
-     * {@link
-     *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
-     *   Initialize the SDK}
+     * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
      * for more details.
      *
      * @example
@@ -54,25 +47,20 @@ export declare namespace credential {
      * });
      * ```
      *
-     * @param {!Object=} httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+     * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
      *   to be used when retrieving access tokens from Google token servers.
      *
-     * @return {!admin.credential.Credential} A credential authenticated via Google
+     * @returns A credential authenticated via Google
      *   Application Default Credentials that can be used to initialize an app.
      */
     const applicationDefault: typeof applicationDefaultFn;
     /**
      * Returns a credential created from the provided service account that grants
      * admin access to Firebase services. This credential can be used in the call
-     * to
-     * {@link
-     *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
-     *   `admin.initializeApp()`}.
+     * to {@link firebase-admin.app#initializeApp}.
      *
      * See
-     * {@link
-     *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
-     *   Initialize the SDK}
+     * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
      * for more details.
      *
      * @example
@@ -98,27 +86,22 @@ export declare namespace credential {
      * });
      * ```
      *
-     * @param serviceAccountPathOrObject The path to a service
+     * @param serviceAccountPathOrObject - The path to a service
      *   account key JSON file or an object representing a service account key.
-     * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+     * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
      *   to be used when retrieving access tokens from Google token servers.
      *
-     * @return A credential authenticated via the
+     * @returns A credential authenticated via the
      *   provided service account that can be used to initialize an app.
      */
     const cert: typeof certFn;
     /**
      * Returns a credential created from the provided refresh token that grants
      * admin access to Firebase services. This credential can be used in the call
-     * to
-     * {@link
-     *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
-     *   `admin.initializeApp()`}.
+     * to {@link firebase-admin.app#initializeApp}.
      *
      * See
-     * {@link
-     *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
-     *   Initialize the SDK}
+     * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
      * for more details.
      *
      * @example
@@ -131,13 +114,13 @@ export declare namespace credential {
      * });
      * ```
      *
-     * @param refreshTokenPathOrObject The path to a Google
+     * @param refreshTokenPathOrObject - The path to a Google
      *   OAuth2 refresh token JSON file or an object representing a Google OAuth2
      *   refresh token.
-     * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+     * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
      *   to be used when retrieving access tokens from Google token servers.
      *
-     * @return A credential authenticated via the
+     * @returns A credential authenticated via the
      *   provided service account that can be used to initialize an app.
      */
     const refreshToken: typeof refreshTokenFn;

package/lib/credential/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -23,22 +23,16 @@ var credential;
 (function (credential) {
     /**
      * Returns a credential created from the
-     * {@link
-     *    https://developers.google.com/identity/protocols/application-default-credentials
-     *    Google Application Default Credentials}
+     * {@link https://developers.google.com/identity/protocols/application-default-credentials |
+     * Google Application Default Credentials}
      * that grants admin access to Firebase services. This credential can be used
-     * in the call to
-     * {@link
-     *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
-     *  `admin.initializeApp()`}.
+     * in the call to {@link firebase-admin.app#initializeApp}.
      *
      * Google Application Default Credentials are available on any Google
      * infrastructure, such as Google App Engine and Google Compute Engine.
      *
      * See
-     * {@link
-     *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
-     *   Initialize the SDK}
+     * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
      * for more details.
      *
      * @example
@@ -49,25 +43,20 @@ var credential;
      * });
      * ```
      *
-     * @param {!Object=} httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+     * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
      *   to be used when retrieving access tokens from Google token servers.
      *
-     * @return {!admin.credential.Credential} A credential authenticated via Google
+     * @returns A credential authenticated via Google
      *   Application Default Credentials that can be used to initialize an app.
      */
     credential.applicationDefault = index_1.applicationDefault;
     /**
      * Returns a credential created from the provided service account that grants
      * admin access to Firebase services. This credential can be used in the call
-     * to
-     * {@link
-     *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
-     *   `admin.initializeApp()`}.
+     * to {@link firebase-admin.app#initializeApp}.
      *
      * See
-     * {@link
-     *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
-     *   Initialize the SDK}
+     * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
      * for more details.
      *
      * @example
@@ -93,27 +82,22 @@ var credential;
      * });
      * ```
      *
-     * @param serviceAccountPathOrObject The path to a service
+     * @param serviceAccountPathOrObject - The path to a service
      *   account key JSON file or an object representing a service account key.
-     * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+     * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
      *   to be used when retrieving access tokens from Google token servers.
      *
-     * @return A credential authenticated via the
+     * @returns A credential authenticated via the
      *   provided service account that can be used to initialize an app.
      */
     credential.cert = index_1.cert;
     /**
      * Returns a credential created from the provided refresh token that grants
      * admin access to Firebase services. This credential can be used in the call
-     * to
-     * {@link
-     *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
-     *   `admin.initializeApp()`}.
+     * to {@link firebase-admin.app#initializeApp}.
      *
      * See
-     * {@link
-     *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
-     *   Initialize the SDK}
+     * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
      * for more details.
      *
      * @example
@@ -126,13 +110,13 @@ var credential;
      * });
      * ```
      *
-     * @param refreshTokenPathOrObject The path to a Google
+     * @param refreshTokenPathOrObject - The path to a Google
      *   OAuth2 refresh token JSON file or an object representing a Google OAuth2
      *   refresh token.
-     * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+     * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
      *   to be used when retrieving access tokens from Google token servers.
      *
-     * @return A credential authenticated via the
+     * @returns A credential authenticated via the
      *   provided service account that can be used to initialize an app.
      */
     credential.refreshToken = index_1.refreshToken;