@azure/arm-education 1.0.0-beta.2 → 1.0.0-beta.3

package/src/operations/labs.ts

@@ -6,7 +6,8 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
 import { Labs } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,9 +17,9 @@ import {
   LabDetails,
   LabsListAllNextOptionalParams,
   LabsListAllOptionalParams,
+  LabsListAllResponse,
   LabsListNextOptionalParams,
   LabsListOptionalParams,
-  LabsListAllResponse,
   LabsListResponse,
   LabsGetOptionalParams,
   LabsGetResponse,
@@ -68,11 +69,15 @@ export class LabsImpl implements Labs {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listAllPagingPage(
           billingAccountName,
           billingProfileName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -81,15 +86,22 @@ export class LabsImpl implements Labs {
   private async *listAllPagingPage(
     billingAccountName: string,
     billingProfileName: string,
-    options?: LabsListAllOptionalParams
+    options?: LabsListAllOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<LabDetails[]> {
-    let result = await this._listAll(
-      billingAccountName,
-      billingProfileName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: LabsListAllResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listAll(
+        billingAccountName,
+        billingProfileName,
+        options
+      );
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listAllNext(
         billingAccountName,
@@ -98,7 +110,9 @@ export class LabsImpl implements Labs {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -143,12 +157,16 @@ export class LabsImpl implements Labs {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listPagingPage(
           billingAccountName,
           billingProfileName,
           invoiceSectionName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -158,16 +176,23 @@ export class LabsImpl implements Labs {
     billingAccountName: string,
     billingProfileName: string,
     invoiceSectionName: string,
-    options?: LabsListOptionalParams
+    options?: LabsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<LabDetails[]> {
-    let result = await this._list(
-      billingAccountName,
-      billingProfileName,
-      invoiceSectionName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: LabsListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(
+        billingAccountName,
+        billingProfileName,
+        invoiceSectionName,
+        options
+      );
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(
         billingAccountName,
@@ -177,7 +202,9 @@ export class LabsImpl implements Labs {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -532,11 +559,6 @@ const listAllNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponseBody
     }
   },
-  queryParameters: [
-    Parameters.apiVersion,
-    Parameters.includeBudget,
-    Parameters.includeDeleted
-  ],
   urlParameters: [
     Parameters.$host,
     Parameters.billingAccountName,
@@ -557,7 +579,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponseBody
     }
   },
-  queryParameters: [Parameters.apiVersion, Parameters.includeBudget],
   urlParameters: [
     Parameters.$host,
     Parameters.billingAccountName,

package/src/operations/studentLabs.ts

@@ -6,7 +6,8 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
 import { StudentLabs } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -50,22 +51,34 @@ export class StudentLabsImpl implements StudentLabs {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listAllPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listAllPagingPage(options, settings);
       }
     };
   }
 
   private async *listAllPagingPage(
-    options?: StudentLabsListAllOptionalParams
+    options?: StudentLabsListAllOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<StudentLabDetails[]> {
-    let result = await this._listAll(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: StudentLabsListAllResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listAll(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listAllNext(continuationToken, options);
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -163,7 +176,6 @@ const listAllNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponseBody
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [Parameters.$host, Parameters.nextLink],
   headerParameters: [Parameters.accept],
   serializer

package/src/operations/students.ts

@@ -6,7 +6,8 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
 import { Students } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -64,12 +65,16 @@ export class StudentsImpl implements Students {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listPagingPage(
           billingAccountName,
           billingProfileName,
           invoiceSectionName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -79,16 +84,23 @@ export class StudentsImpl implements Students {
     billingAccountName: string,
     billingProfileName: string,
     invoiceSectionName: string,
-    options?: StudentsListOptionalParams
+    options?: StudentsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<StudentDetails[]> {
-    let result = await this._list(
-      billingAccountName,
-      billingProfileName,
-      invoiceSectionName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: StudentsListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(
+        billingAccountName,
+        billingProfileName,
+        invoiceSectionName,
+        options
+      );
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(
         billingAccountName,
@@ -98,7 +110,9 @@ export class StudentsImpl implements Students {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -358,7 +372,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponseBody
     }
   },
-  queryParameters: [Parameters.apiVersion, Parameters.includeDeleted],
   urlParameters: [
     Parameters.$host,
     Parameters.billingAccountName,

package/src/pagingHelper.ts

@@ -0,0 +1,39 @@
+/*
+ * 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.
+ */
+
+export interface PageInfo {
+  continuationToken?: string;
+}
+
+const pageMap = new WeakMap<object, PageInfo>();
+
+/**
+ * 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 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) {
+    return undefined;
+  }
+  return pageMap.get(page)?.continuationToken;
+}
+
+export function setContinuationToken(
+  page: unknown,
+  continuationToken: string | undefined
+): void {
+  if (typeof page !== "object" || page === null || !continuationToken) {
+    return;
+  }
+  const pageInfo = pageMap.get(page) ?? {};
+  pageInfo.continuationToken = continuationToken;
+  pageMap.set(page, pageInfo);
+}

package/types/arm-education.d.ts

@@ -80,6 +80,15 @@ export declare interface ErrorResponseBody {
     error?: ErrorResponse;
 }
 
+/**
+ * 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 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 declare function getContinuationToken(page: unknown): string | undefined;
+
 /** Grant details. */
 export declare interface GrantDetails extends Resource {
     /**
@@ -162,8 +171,6 @@ export declare type GrantsGetResponse = GrantDetails;
 
 /** Optional parameters. */
 export declare interface GrantsListAllNextOptionalParams extends coreClient.OperationOptions {
-    /** May be used to include information about budget that has been allocated. */
-    includeAllocatedBudget?: boolean;
 }
 
 /** Contains response data for the listAllNext operation. */
@@ -180,8 +187,6 @@ export declare type GrantsListAllResponse = GrantListResponse;
 
 /** Optional parameters. */
 export declare interface GrantsListNextOptionalParams extends coreClient.OperationOptions {
-    /** May be used to include information about budget that has been allocated. */
-    includeAllocatedBudget?: boolean;
 }
 
 /** Contains response data for the listNext operation. */
@@ -304,8 +309,6 @@ export declare type JoinRequestsGetResponse = JoinRequestDetails;
 
 /** Optional parameters. */
 export declare interface JoinRequestsListNextOptionalParams extends coreClient.OperationOptions {
-    /** Include denied */
-    includeDenied?: boolean;
 }
 
 /** Contains response data for the listNext operation. */
@@ -555,10 +558,6 @@ export declare type LabsGetResponse = LabDetails;
 
 /** Optional parameters. */
 export declare interface LabsListAllNextOptionalParams extends coreClient.OperationOptions {
-    /** May be used to include budget information. */
-    includeBudget?: boolean;
-    /** May be used to show deleted items. */
-    includeDeleted?: boolean;
 }
 
 /** Contains response data for the listAllNext operation. */
@@ -577,8 +576,6 @@ export declare type LabsListAllResponse = LabListResult;
 
 /** Optional parameters. */
 export declare interface LabsListNextOptionalParams extends coreClient.OperationOptions {
-    /** May be used to include budget information. */
-    includeBudget?: boolean;
 }
 
 /** Contains response data for the listNext operation. */
@@ -965,8 +962,6 @@ export declare type StudentsGetResponse = StudentDetails;
 
 /** Optional parameters. */
 export declare interface StudentsListNextOptionalParams extends coreClient.OperationOptions {
-    /** May be used to show deleted items. */
-    includeDeleted?: boolean;
 }
 
 /** Contains response data for the listNext operation. */

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.18.11"
+      "packageVersion": "7.34.2"
     }
   ]
 }