@azure/arm-reservations 7.2.1-alpha.20230202.1 → 8.0.0-alpha.20230210.2

package/src/operations/reservation.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 { Reservation } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -18,10 +19,13 @@ import {
   ReservationResponse,
   ReservationListNextOptionalParams,
   ReservationListOptionalParams,
+  ReservationListResponse,
   ReservationListRevisionsNextOptionalParams,
   ReservationListRevisionsOptionalParams,
+  ReservationListRevisionsResponse,
   ReservationListAllNextOptionalParams,
   ReservationListAllOptionalParams,
+  ReservationListAllResponse,
   AvailableScopeRequest,
   ReservationAvailableScopesOptionalParams,
   ReservationAvailableScopesResponse,
@@ -31,7 +35,6 @@ import {
   MergeRequest,
   ReservationMergeOptionalParams,
   ReservationMergeResponse,
-  ReservationListResponse,
   ReservationGetOptionalParams,
   ReservationGetResponse,
   Patch,
@@ -39,8 +42,6 @@ import {
   ReservationUpdateResponse,
   ReservationArchiveOptionalParams,
   ReservationUnarchiveOptionalParams,
-  ReservationListRevisionsResponse,
-  ReservationListAllResponse,
   ReservationListNextResponse,
   ReservationListRevisionsNextResponse,
   ReservationListAllNextResponse
@@ -76,19 +77,29 @@ export class ReservationImpl implements Reservation {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listPagingPage(reservationOrderId, options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(reservationOrderId, options, settings);
       }
     };
   }
 
   private async *listPagingPage(
     reservationOrderId: string,
-    options?: ReservationListOptionalParams
+    options?: ReservationListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ReservationResponse[]> {
-    let result = await this._list(reservationOrderId, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ReservationListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(reservationOrderId, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(
         reservationOrderId,
@@ -96,7 +107,9 @@ export class ReservationImpl implements Reservation {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -111,18 +124,18 @@ export class ReservationImpl implements Reservation {
 
   /**
    * List of all the revisions for the `Reservation`.
-   * @param reservationId Id of the Reservation Item
    * @param reservationOrderId Order Id of the reservation
+   * @param reservationId Id of the reservation item
    * @param options The options parameters.
    */
   public listRevisions(
-    reservationId: string,
     reservationOrderId: string,
+    reservationId: string,
     options?: ReservationListRevisionsOptionalParams
   ): PagedAsyncIterableIterator<ReservationResponse> {
     const iter = this.listRevisionsPagingAll(
-      reservationId,
       reservationOrderId,
+      reservationId,
       options
     );
     return {
@@ -132,48 +145,61 @@ export class ReservationImpl implements Reservation {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listRevisionsPagingPage(
-          reservationId,
           reservationOrderId,
-          options
+          reservationId,
+          options,
+          settings
         );
       }
     };
   }
 
   private async *listRevisionsPagingPage(
-    reservationId: string,
     reservationOrderId: string,
-    options?: ReservationListRevisionsOptionalParams
+    reservationId: string,
+    options?: ReservationListRevisionsOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ReservationResponse[]> {
-    let result = await this._listRevisions(
-      reservationId,
-      reservationOrderId,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ReservationListRevisionsResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listRevisions(
+        reservationOrderId,
+        reservationId,
+        options
+      );
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listRevisionsNext(
-        reservationId,
         reservationOrderId,
+        reservationId,
         continuationToken,
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
   private async *listRevisionsPagingAll(
-    reservationId: string,
     reservationOrderId: string,
+    reservationId: string,
     options?: ReservationListRevisionsOptionalParams
   ): AsyncIterableIterator<ReservationResponse> {
     for await (const page of this.listRevisionsPagingPage(
-      reservationId,
       reservationOrderId,
+      reservationId,
       options
     )) {
       yield* page;
@@ -196,22 +222,34 @@ export class ReservationImpl implements Reservation {
       [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?: ReservationListAllOptionalParams
+    options?: ReservationListAllOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ReservationResponse[]> {
-    let result = await this._listAll(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ReservationListAllResponse;
+    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;
     }
   }
 
@@ -224,11 +262,11 @@ export class ReservationImpl implements Reservation {
   }
 
   /**
-   * Get Available Scopes for `Reservation`.
+   * Check whether the scopes from request is valid for `Reservation`.
    *
    * @param reservationOrderId Order Id of the reservation
-   * @param reservationId Id of the Reservation Item
-   * @param body Available scope
+   * @param reservationId Id of the reservation item
+   * @param body Scopes to be checked for eligibility.
    * @param options The options parameters.
    */
   async beginAvailableScopes(
@@ -295,11 +333,11 @@ export class ReservationImpl implements Reservation {
   }
 
   /**
-   * Get Available Scopes for `Reservation`.
+   * Check whether the scopes from request is valid for `Reservation`.
    *
    * @param reservationOrderId Order Id of the reservation
-   * @param reservationId Id of the Reservation Item
-   * @param body Available scope
+   * @param reservationId Id of the reservation item
+   * @param body Scopes to be checked for eligibility.
    * @param options The options parameters.
    */
   async beginAvailableScopesAndWait(
@@ -504,17 +542,17 @@ export class ReservationImpl implements Reservation {
 
   /**
    * Get specific `Reservation` details.
-   * @param reservationId Id of the Reservation Item
    * @param reservationOrderId Order Id of the reservation
+   * @param reservationId Id of the reservation item
    * @param options The options parameters.
    */
   get(
-    reservationId: string,
     reservationOrderId: string,
+    reservationId: string,
     options?: ReservationGetOptionalParams
   ): Promise<ReservationGetResponse> {
     return this.client.sendOperationRequest(
-      { reservationId, reservationOrderId, options },
+      { reservationOrderId, reservationId, options },
       getOperationSpec
     );
   }
@@ -522,7 +560,7 @@ export class ReservationImpl implements Reservation {
   /**
    * Updates the applied scopes of the `Reservation`.
    * @param reservationOrderId Order Id of the reservation
-   * @param reservationId Id of the Reservation Item
+   * @param reservationId Id of the reservation item
    * @param parameters Information needed to patch a reservation item
    * @param options The options parameters.
    */
@@ -583,7 +621,8 @@ export class ReservationImpl implements Reservation {
     );
     const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
-      intervalInMs: options?.updateIntervalInMs
+      intervalInMs: options?.updateIntervalInMs,
+      lroResourceLocationConfig: "azure-async-operation"
     });
     await poller.poll();
     return poller;
@@ -592,7 +631,7 @@ export class ReservationImpl implements Reservation {
   /**
    * Updates the applied scopes of the `Reservation`.
    * @param reservationOrderId Order Id of the reservation
-   * @param reservationId Id of the Reservation Item
+   * @param reservationId Id of the reservation item
    * @param parameters Information needed to patch a reservation item
    * @param options The options parameters.
    */
@@ -614,7 +653,7 @@ export class ReservationImpl implements Reservation {
   /**
    * Archiving a `Reservation` moves it to `Archived` state.
    * @param reservationOrderId Order Id of the reservation
-   * @param reservationId Id of the Reservation Item
+   * @param reservationId Id of the reservation item
    * @param options The options parameters.
    */
   archive(
@@ -629,10 +668,10 @@ export class ReservationImpl implements Reservation {
   }
 
   /**
-   * Unarchiving a `Reservation` moves it to the state it was before archiving.
+   * Restores a `Reservation` to the state it was before archiving.
    *
    * @param reservationOrderId Order Id of the reservation
-   * @param reservationId Id of the Reservation Item
+   * @param reservationId Id of the reservation item
    * @param options The options parameters.
    */
   unarchive(
@@ -648,17 +687,17 @@ export class ReservationImpl implements Reservation {
 
   /**
    * List of all the revisions for the `Reservation`.
-   * @param reservationId Id of the Reservation Item
    * @param reservationOrderId Order Id of the reservation
+   * @param reservationId Id of the reservation item
    * @param options The options parameters.
    */
   private _listRevisions(
-    reservationId: string,
     reservationOrderId: string,
+    reservationId: string,
     options?: ReservationListRevisionsOptionalParams
   ): Promise<ReservationListRevisionsResponse> {
     return this.client.sendOperationRequest(
-      { reservationId, reservationOrderId, options },
+      { reservationOrderId, reservationId, options },
       listRevisionsOperationSpec
     );
   }
@@ -693,19 +732,19 @@ export class ReservationImpl implements Reservation {
 
   /**
    * ListRevisionsNext
-   * @param reservationId Id of the Reservation Item
    * @param reservationOrderId Order Id of the reservation
+   * @param reservationId Id of the reservation item
    * @param nextLink The nextLink from the previous successful call to the ListRevisions method.
    * @param options The options parameters.
    */
   private _listRevisionsNext(
-    reservationId: string,
     reservationOrderId: string,
+    reservationId: string,
     nextLink: string,
     options?: ReservationListRevisionsNextOptionalParams
   ): Promise<ReservationListRevisionsNextResponse> {
     return this.client.sendOperationRequest(
-      { reservationId, reservationOrderId, nextLink, options },
+      { reservationOrderId, reservationId, nextLink, options },
       listRevisionsNextOperationSpec
     );
   }
@@ -1036,7 +1075,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.reservationOrderId,
@@ -1056,7 +1094,6 @@ const listRevisionsNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.reservationOrderId,
@@ -1077,15 +1114,6 @@ const listAllNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [
-    Parameters.apiVersion,
-    Parameters.filter,
-    Parameters.orderby,
-    Parameters.refreshSummary,
-    Parameters.skiptoken,
-    Parameters.selectedState,
-    Parameters.take
-  ],
   urlParameters: [Parameters.$host, Parameters.nextLink],
   headerParameters: [Parameters.accept],
   serializer

package/src/operations/reservationOrder.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 { ReservationOrder } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -18,10 +19,10 @@ import {
   ReservationOrderResponse,
   ReservationOrderListNextOptionalParams,
   ReservationOrderListOptionalParams,
+  ReservationOrderListResponse,
   PurchaseRequest,
   ReservationOrderCalculateOptionalParams,
   ReservationOrderCalculateResponse,
-  ReservationOrderListResponse,
   ReservationOrderPurchaseOptionalParams,
   ReservationOrderPurchaseResponse,
   ReservationOrderGetOptionalParams,
@@ -60,22 +61,34 @@ export class ReservationOrderImpl implements ReservationOrder {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(options, settings);
       }
     };
   }
 
   private async *listPagingPage(
-    options?: ReservationOrderListOptionalParams
+    options?: ReservationOrderListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ReservationOrderResponse[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ReservationOrderListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(continuationToken, options);
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -319,7 +332,7 @@ const getOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [Parameters.apiVersion, Parameters.expand1],
+  queryParameters: [Parameters.apiVersion, Parameters.expand],
   urlParameters: [Parameters.$host, Parameters.reservationOrderId],
   headerParameters: [Parameters.accept],
   serializer
@@ -354,7 +367,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [Parameters.$host, Parameters.nextLink],
   headerParameters: [Parameters.accept],
   serializer

package/src/operations/return.ts

@@ -11,6 +11,8 @@ import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
 import { AzureReservationAPI } from "../azureReservationAPI";
+import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro";
+import { LroImpl } from "../lroImpl";
 import {
   RefundRequest,
   ReturnPostOptionalParams,
@@ -30,20 +32,84 @@ export class ReturnImpl implements Return {
   }
 
   /**
-   * Return a reservation.
+   * Return a reservation and get refund information.
    * @param reservationOrderId Order Id of the reservation
    * @param body Information needed for returning reservation.
    * @param options The options parameters.
    */
-  post(
+  async beginPost(
     reservationOrderId: string,
     body: RefundRequest,
     options?: ReturnPostOptionalParams
-  ): Promise<ReturnPostResponse> {
-    return this.client.sendOperationRequest(
+  ): Promise<
+    PollerLike<PollOperationState<ReturnPostResponse>, ReturnPostResponse>
+  > {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<ReturnPostResponse> => {
+      return this.client.sendOperationRequest(args, spec);
+    };
+    const sendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ) => {
+      let currentRawResponse:
+        | coreClient.FullOperationResponse
+        | undefined = undefined;
+      const providedCallback = args.options?.onResponse;
+      const callback: coreClient.RawResponseCallback = (
+        rawResponse: coreClient.FullOperationResponse,
+        flatResponse: unknown
+      ) => {
+        currentRawResponse = rawResponse;
+        providedCallback?.(rawResponse, flatResponse);
+      };
+      const updatedArgs = {
+        ...args,
+        options: {
+          ...args.options,
+          onResponse: callback
+        }
+      };
+      const flatResponse = await directSendOperation(updatedArgs, spec);
+      return {
+        flatResponse,
+        rawResponse: {
+          statusCode: currentRawResponse!.status,
+          body: currentRawResponse!.parsedBody,
+          headers: currentRawResponse!.headers.toJSON()
+        }
+      };
+    };
+
+    const lro = new LroImpl(
+      sendOperation,
       { reservationOrderId, body, options },
       postOperationSpec
     );
+    const poller = new LroEngine(lro, {
+      resumeFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      lroResourceLocationConfig: "location"
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * Return a reservation and get refund information.
+   * @param reservationOrderId Order Id of the reservation
+   * @param body Information needed for returning reservation.
+   * @param options The options parameters.
+   */
+  async beginPostAndWait(
+    reservationOrderId: string,
+    body: RefundRequest,
+    options?: ReturnPostOptionalParams
+  ): Promise<ReturnPostResponse> {
+    const poller = await this.beginPost(reservationOrderId, body, options);
+    return poller.pollUntilDone();
   }
 }
 // Operation Specifications
@@ -54,10 +120,22 @@ const postOperationSpec: coreClient.OperationSpec = {
     "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/return",
   httpMethod: "POST",
   responses: {
+    200: {
+      bodyMapper: Mappers.RefundResponse,
+      headersMapper: Mappers.ReturnPostHeaders
+    },
+    201: {
+      bodyMapper: Mappers.RefundResponse,
+      headersMapper: Mappers.ReturnPostHeaders
+    },
     202: {
       bodyMapper: Mappers.RefundResponse,
       headersMapper: Mappers.ReturnPostHeaders
     },
+    204: {
+      bodyMapper: Mappers.RefundResponse,
+      headersMapper: Mappers.ReturnPostHeaders
+    },
     default: {
       bodyMapper: Mappers.ErrorModel
     }