@azure/arm-keyvault 2.1.0-beta.2 → 3.0.0-alpha.20230424.3

package/src/operations/privateEndpointConnections.ts

@@ -13,8 +13,12 @@ import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
 import { KeyVaultManagementClient } from "../keyVaultManagementClient";
-import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro";
-import { LroImpl } from "../lroImpl";
+import {
+  SimplePollerLike,
+  OperationState,
+  createHttpPoller
+} from "@azure/core-lro";
+import { createLroSpec } from "../lroImpl";
 import {
   PrivateEndpointConnection,
   PrivateEndpointConnectionsListByResourceNextOptionalParams,
@@ -190,8 +194,8 @@ export class PrivateEndpointConnectionsImpl
     privateEndpointConnectionName: string,
     options?: PrivateEndpointConnectionsDeleteOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<PrivateEndpointConnectionsDeleteResponse>,
+    SimplePollerLike<
+      OperationState<PrivateEndpointConnectionsDeleteResponse>,
       PrivateEndpointConnectionsDeleteResponse
     >
   > {
@@ -201,7 +205,7 @@ export class PrivateEndpointConnectionsImpl
     ): Promise<PrivateEndpointConnectionsDeleteResponse> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -234,13 +238,21 @@ export class PrivateEndpointConnectionsImpl
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      { resourceGroupName, vaultName, privateEndpointConnectionName, options },
-      deleteOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: {
+        resourceGroupName,
+        vaultName,
+        privateEndpointConnectionName,
+        options
+      },
+      spec: deleteOperationSpec
+    });
+    const poller = await createHttpPoller<
+      PrivateEndpointConnectionsDeleteResponse,
+      OperationState<PrivateEndpointConnectionsDeleteResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
     await poller.poll();
@@ -425,7 +437,6 @@ const listByResourceNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,

package/src/operations/secrets.ts

@@ -126,7 +126,9 @@ export class SecretsImpl implements Secrets {
    * with vault secrets.
    * @param resourceGroupName The name of the Resource Group to which the vault belongs.
    * @param vaultName Name of the vault
-   * @param secretName Name of the secret
+   * @param secretName Name of the secret. The value you provide may be copied globally for the purpose
+   *                   of running the service. The value provided should not include personally identifiable or sensitive
+   *                   information.
    * @param parameters Parameters to create or update the secret
    * @param options The options parameters.
    */
@@ -241,7 +243,7 @@ const createOrUpdateOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  requestBody: Parameters.parameters5,
+  requestBody: Parameters.parameters6,
   queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
@@ -269,7 +271,7 @@ const updateOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  requestBody: Parameters.parameters6,
+  requestBody: Parameters.parameters7,
   queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
@@ -338,7 +340,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion, Parameters.top],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,

package/src/operations/vaults.ts

@@ -13,8 +13,12 @@ import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
 import { KeyVaultManagementClient } from "../keyVaultManagementClient";
-import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro";
-import { LroImpl } from "../lroImpl";
+import {
+  SimplePollerLike,
+  OperationState,
+  createHttpPoller
+} from "@azure/core-lro";
+import { createLroSpec } from "../lroImpl";
 import {
   Vault,
   VaultsListByResourceGroupNextOptionalParams,
@@ -314,8 +318,8 @@ export class VaultsImpl implements Vaults {
     parameters: VaultCreateOrUpdateParameters,
     options?: VaultsCreateOrUpdateOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<VaultsCreateOrUpdateResponse>,
+    SimplePollerLike<
+      OperationState<VaultsCreateOrUpdateResponse>,
       VaultsCreateOrUpdateResponse
     >
   > {
@@ -325,7 +329,7 @@ export class VaultsImpl implements Vaults {
     ): Promise<VaultsCreateOrUpdateResponse> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -358,13 +362,16 @@ export class VaultsImpl implements Vaults {
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      { resourceGroupName, vaultName, parameters, options },
-      createOrUpdateOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: { resourceGroupName, vaultName, parameters, options },
+      spec: createOrUpdateOperationSpec
+    });
+    const poller = await createHttpPoller<
+      VaultsCreateOrUpdateResponse,
+      OperationState<VaultsCreateOrUpdateResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
     await poller.poll();
@@ -536,14 +543,14 @@ export class VaultsImpl implements Vaults {
     vaultName: string,
     location: string,
     options?: VaultsPurgeDeletedOptionalParams
-  ): Promise<PollerLike<PollOperationState<void>, void>> {
+  ): Promise<SimplePollerLike<OperationState<void>, void>> {
     const directSendOperation = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ): Promise<void> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -576,13 +583,13 @@ export class VaultsImpl implements Vaults {
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      { vaultName, location, options },
-      purgeDeletedOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: { vaultName, location, options },
+      spec: purgeDeletedOperationSpec
+    });
+    const poller = await createHttpPoller<void, OperationState<void>>(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
     await poller.poll();
@@ -715,7 +722,7 @@ const createOrUpdateOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  requestBody: Parameters.parameters1,
+  requestBody: Parameters.parameters2,
   queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
@@ -742,7 +749,7 @@ const updateOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  requestBody: Parameters.parameters2,
+  requestBody: Parameters.parameters3,
   queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
@@ -812,7 +819,7 @@ const updateAccessPolicyOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  requestBody: Parameters.parameters3,
+  requestBody: Parameters.parameters4,
   queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
@@ -970,7 +977,6 @@ const listByResourceGroupNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion, Parameters.top],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,
@@ -991,7 +997,6 @@ const listBySubscriptionNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion, Parameters.top],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,
@@ -1011,7 +1016,6 @@ const listDeletedNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,
@@ -1031,7 +1035,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.top, Parameters.filter, Parameters.apiVersion1],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,

package/src/operationsInterfaces/index.ts

@@ -7,11 +7,13 @@
  */
 
 export * from "./keys";
+export * from "./managedHsmKeys";
 export * from "./vaults";
 export * from "./privateEndpointConnections";
 export * from "./privateLinkResources";
 export * from "./managedHsms";
 export * from "./mhsmPrivateEndpointConnections";
 export * from "./mhsmPrivateLinkResources";
+export * from "./mhsmRegions";
 export * from "./operations";
 export * from "./secrets";

package/src/operationsInterfaces/keys.ts

@@ -53,7 +53,9 @@ export interface Keys {
    * versions, and does not update existing keys.
    * @param resourceGroupName The name of the resource group which contains the specified key vault.
    * @param vaultName The name of the key vault which contains the key to be created.
-   * @param keyName The name of the key to be created.
+   * @param keyName The name of the key to be created. The value you provide may be copied globally for
+   *                the purpose of running the service. The value provided should not include personally identifiable or
+   *                sensitive information.
    * @param parameters The parameters used to create the specified key.
    * @param options The options parameters.
    */

package/src/operationsInterfaces/managedHsmKeys.ts

@@ -0,0 +1,103 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import {
+  ManagedHsmKey,
+  ManagedHsmKeysListOptionalParams,
+  ManagedHsmKeysListVersionsOptionalParams,
+  ManagedHsmKeyCreateParameters,
+  ManagedHsmKeysCreateIfNotExistOptionalParams,
+  ManagedHsmKeysCreateIfNotExistResponse,
+  ManagedHsmKeysGetOptionalParams,
+  ManagedHsmKeysGetResponse,
+  ManagedHsmKeysGetVersionOptionalParams,
+  ManagedHsmKeysGetVersionResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a ManagedHsmKeys. */
+export interface ManagedHsmKeys {
+  /**
+   * Lists the keys in the specified managed HSM.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param name The name of the Managed HSM Pool within the specified resource group.
+   * @param options The options parameters.
+   */
+  list(
+    resourceGroupName: string,
+    name: string,
+    options?: ManagedHsmKeysListOptionalParams
+  ): PagedAsyncIterableIterator<ManagedHsmKey>;
+  /**
+   * Lists the versions of the specified key in the specified managed HSM.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param name The name of the Managed HSM Pool within the specified resource group.
+   * @param keyName The name of the key to be created. The value you provide may be copied globally for
+   *                the purpose of running the service. The value provided should not include personally identifiable or
+   *                sensitive information.
+   * @param options The options parameters.
+   */
+  listVersions(
+    resourceGroupName: string,
+    name: string,
+    keyName: string,
+    options?: ManagedHsmKeysListVersionsOptionalParams
+  ): PagedAsyncIterableIterator<ManagedHsmKey>;
+  /**
+   * Creates the first version of a new key if it does not exist. If it already exists, then the existing
+   * key is returned without any write operations being performed. This API does not create subsequent
+   * versions, and does not update existing keys.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param name The name of the Managed HSM Pool within the specified resource group.
+   * @param keyName The name of the key to be created. The value you provide may be copied globally for
+   *                the purpose of running the service. The value provided should not include personally identifiable or
+   *                sensitive information.
+   * @param parameters The parameters used to create the specified key.
+   * @param options The options parameters.
+   */
+  createIfNotExist(
+    resourceGroupName: string,
+    name: string,
+    keyName: string,
+    parameters: ManagedHsmKeyCreateParameters,
+    options?: ManagedHsmKeysCreateIfNotExistOptionalParams
+  ): Promise<ManagedHsmKeysCreateIfNotExistResponse>;
+  /**
+   * Gets the current version of the specified key from the specified managed HSM.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param name The name of the Managed HSM Pool within the specified resource group.
+   * @param keyName The name of the key to be created. The value you provide may be copied globally for
+   *                the purpose of running the service. The value provided should not include personally identifiable or
+   *                sensitive information.
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    name: string,
+    keyName: string,
+    options?: ManagedHsmKeysGetOptionalParams
+  ): Promise<ManagedHsmKeysGetResponse>;
+  /**
+   * Gets the specified version of the specified key in the specified managed HSM.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param name The name of the Managed HSM Pool within the specified resource group.
+   * @param keyName The name of the key to be created. The value you provide may be copied globally for
+   *                the purpose of running the service. The value provided should not include personally identifiable or
+   *                sensitive information.
+   * @param keyVersion The version of the key to be retrieved.
+   * @param options The options parameters.
+   */
+  getVersion(
+    resourceGroupName: string,
+    name: string,
+    keyName: string,
+    keyVersion: string,
+    options?: ManagedHsmKeysGetVersionOptionalParams
+  ): Promise<ManagedHsmKeysGetVersionResponse>;
+}

package/src/operationsInterfaces/managedHsms.ts

@@ -7,7 +7,7 @@
  */
 
 import { PagedAsyncIterableIterator } from "@azure/core-paging";
-import { PollerLike, PollOperationState } from "@azure/core-lro";
+import { SimplePollerLike, OperationState } from "@azure/core-lro";
 import {
   ManagedHsm,
   ManagedHsmsListByResourceGroupOptionalParams,
@@ -23,7 +23,11 @@ import {
   ManagedHsmsGetResponse,
   ManagedHsmsGetDeletedOptionalParams,
   ManagedHsmsGetDeletedResponse,
-  ManagedHsmsPurgeDeletedOptionalParams
+  ManagedHsmsPurgeDeletedOptionalParams,
+  ManagedHsmsPurgeDeletedResponse,
+  CheckMhsmNameAvailabilityParameters,
+  ManagedHsmsCheckMhsmNameAvailabilityOptionalParams,
+  ManagedHsmsCheckMhsmNameAvailabilityResponse
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -66,8 +70,8 @@ export interface ManagedHsms {
     parameters: ManagedHsm,
     options?: ManagedHsmsCreateOrUpdateOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<ManagedHsmsCreateOrUpdateResponse>,
+    SimplePollerLike<
+      OperationState<ManagedHsmsCreateOrUpdateResponse>,
       ManagedHsmsCreateOrUpdateResponse
     >
   >;
@@ -97,8 +101,8 @@ export interface ManagedHsms {
     parameters: ManagedHsm,
     options?: ManagedHsmsUpdateOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<ManagedHsmsUpdateResponse>,
+    SimplePollerLike<
+      OperationState<ManagedHsmsUpdateResponse>,
       ManagedHsmsUpdateResponse
     >
   >;
@@ -125,7 +129,7 @@ export interface ManagedHsms {
     resourceGroupName: string,
     name: string,
     options?: ManagedHsmsDeleteOptionalParams
-  ): Promise<PollerLike<PollOperationState<void>, void>>;
+  ): Promise<SimplePollerLike<OperationState<void>, void>>;
   /**
    * Deletes the specified managed HSM Pool.
    * @param resourceGroupName Name of the resource group that contains the managed HSM pool.
@@ -169,7 +173,12 @@ export interface ManagedHsms {
     name: string,
     location: string,
     options?: ManagedHsmsPurgeDeletedOptionalParams
-  ): Promise<PollerLike<PollOperationState<void>, void>>;
+  ): Promise<
+    SimplePollerLike<
+      OperationState<ManagedHsmsPurgeDeletedResponse>,
+      ManagedHsmsPurgeDeletedResponse
+    >
+  >;
   /**
    * Permanently deletes the specified managed HSM.
    * @param name The name of the soft-deleted managed HSM.
@@ -180,5 +189,14 @@ export interface ManagedHsms {
     name: string,
     location: string,
     options?: ManagedHsmsPurgeDeletedOptionalParams
-  ): Promise<void>;
+  ): Promise<ManagedHsmsPurgeDeletedResponse>;
+  /**
+   * Checks that the managed hsm name is valid and is not already in use.
+   * @param mhsmName The name of the managed hsm.
+   * @param options The options parameters.
+   */
+  checkMhsmNameAvailability(
+    mhsmName: CheckMhsmNameAvailabilityParameters,
+    options?: ManagedHsmsCheckMhsmNameAvailabilityOptionalParams
+  ): Promise<ManagedHsmsCheckMhsmNameAvailabilityResponse>;
 }

package/src/operationsInterfaces/mhsmPrivateEndpointConnections.ts

@@ -7,7 +7,7 @@
  */
 
 import { PagedAsyncIterableIterator } from "@azure/core-paging";
-import { PollerLike, PollOperationState } from "@azure/core-lro";
+import { SimplePollerLike, OperationState } from "@azure/core-lro";
 import {
   MhsmPrivateEndpointConnection,
   MhsmPrivateEndpointConnectionsListByResourceOptionalParams,
@@ -78,8 +78,8 @@ export interface MhsmPrivateEndpointConnections {
     privateEndpointConnectionName: string,
     options?: MhsmPrivateEndpointConnectionsDeleteOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<MhsmPrivateEndpointConnectionsDeleteResponse>,
+    SimplePollerLike<
+      OperationState<MhsmPrivateEndpointConnectionsDeleteResponse>,
       MhsmPrivateEndpointConnectionsDeleteResponse
     >
   >;

package/src/operationsInterfaces/mhsmRegions.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import {
+  MhsmGeoReplicatedRegion,
+  MhsmRegionsListByResourceOptionalParams
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a MhsmRegions. */
+export interface MhsmRegions {
+  /**
+   * The List operation gets information about the regions associated with the managed HSM Pool.
+   * @param resourceGroupName Name of the resource group that contains the managed HSM pool.
+   * @param name Name of the managed HSM Pool
+   * @param options The options parameters.
+   */
+  listByResource(
+    resourceGroupName: string,
+    name: string,
+    options?: MhsmRegionsListByResourceOptionalParams
+  ): PagedAsyncIterableIterator<MhsmGeoReplicatedRegion>;
+}

package/src/operationsInterfaces/privateEndpointConnections.ts

@@ -7,7 +7,7 @@
  */
 
 import { PagedAsyncIterableIterator } from "@azure/core-paging";
-import { PollerLike, PollOperationState } from "@azure/core-lro";
+import { SimplePollerLike, OperationState } from "@azure/core-lro";
 import {
   PrivateEndpointConnection,
   PrivateEndpointConnectionsListByResourceOptionalParams,
@@ -78,8 +78,8 @@ export interface PrivateEndpointConnections {
     privateEndpointConnectionName: string,
     options?: PrivateEndpointConnectionsDeleteOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<PrivateEndpointConnectionsDeleteResponse>,
+    SimplePollerLike<
+      OperationState<PrivateEndpointConnectionsDeleteResponse>,
       PrivateEndpointConnectionsDeleteResponse
     >
   >;

package/src/operationsInterfaces/secrets.ts

@@ -42,7 +42,9 @@ export interface Secrets {
    * with vault secrets.
    * @param resourceGroupName The name of the Resource Group to which the vault belongs.
    * @param vaultName Name of the vault
-   * @param secretName Name of the secret
+   * @param secretName Name of the secret. The value you provide may be copied globally for the purpose
+   *                   of running the service. The value provided should not include personally identifiable or sensitive
+   *                   information.
    * @param parameters Parameters to create or update the secret
    * @param options The options parameters.
    */

package/src/operationsInterfaces/vaults.ts

@@ -7,7 +7,7 @@
  */
 
 import { PagedAsyncIterableIterator } from "@azure/core-paging";
-import { PollerLike, PollOperationState } from "@azure/core-lro";
+import { SimplePollerLike, OperationState } from "@azure/core-lro";
 import {
   Vault,
   VaultsListByResourceGroupOptionalParams,
@@ -84,8 +84,8 @@ export interface Vaults {
     parameters: VaultCreateOrUpdateParameters,
     options?: VaultsCreateOrUpdateOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<VaultsCreateOrUpdateResponse>,
+    SimplePollerLike<
+      OperationState<VaultsCreateOrUpdateResponse>,
       VaultsCreateOrUpdateResponse
     >
   >;
@@ -173,7 +173,7 @@ export interface Vaults {
     vaultName: string,
     location: string,
     options?: VaultsPurgeDeletedOptionalParams
-  ): Promise<PollerLike<PollOperationState<void>, void>>;
+  ): Promise<SimplePollerLike<OperationState<void>, void>>;
   /**
    * Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
    * @param vaultName The name of the soft-deleted vault.

package/src/pagingHelper.ts

@@ -13,11 +13,11 @@ export interface PageInfo {
 const pageMap = new WeakMap<object, PageInfo>();
 
 /**
- * Given a result page from a pageable operation, returns a
- * continuation token that can be used to begin paging from
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
  * that point later.
- * @param page A result object from calling .byPage() on a paged operation.
- * @returns The continuation token that can be passed into byPage().
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
  */
 export function getContinuationToken(page: unknown): string | undefined {
   if (typeof page !== "object" || page === null) {