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

package/review/arm-education.api.md

@@ -61,14 +61,17 @@ export interface ErrorResponseBody {
 }
 
 // @public
-export type GrantDetails = Resource & {
-    readonly offerCap?: Amount;
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export interface GrantDetails extends Resource {
+    readonly allocatedBudget?: Amount;
     readonly effectiveDate?: Date;
-    readonly offerType?: GrantType;
     readonly expirationDate?: Date;
+    readonly offerCap?: Amount;
+    readonly offerType?: GrantType;
     readonly status?: GrantStatus;
-    readonly allocatedBudget?: Amount;
-};
+}
 
 // @public
 export interface GrantListResponse {
@@ -93,7 +96,6 @@ export type GrantsGetResponse = GrantDetails;
 
 // @public
 export interface GrantsListAllNextOptionalParams extends coreClient.OperationOptions {
-    includeAllocatedBudget?: boolean;
 }
 
 // @public
@@ -109,7 +111,6 @@ export type GrantsListAllResponse = GrantListResponse;
 
 // @public
 export interface GrantsListNextOptionalParams extends coreClient.OperationOptions {
-    includeAllocatedBudget?: boolean;
 }
 
 // @public
@@ -135,12 +136,12 @@ export interface InviteCodeGenerateRequest {
 }
 
 // @public
-export type JoinRequestDetails = Resource & {
+export interface JoinRequestDetails extends Resource {
+    email?: string;
     firstName?: string;
     lastName?: string;
-    email?: string;
     status?: JoinRequestStatus;
-};
+}
 
 // @public
 export interface JoinRequestList {
@@ -173,7 +174,6 @@ export type JoinRequestsGetResponse = JoinRequestDetails;
 
 // @public
 export interface JoinRequestsListNextOptionalParams extends coreClient.OperationOptions {
-    includeDenied?: boolean;
 }
 
 // @public
@@ -192,101 +192,79 @@ export type JoinRequestStatus = string;
 
 // @public
 export enum KnownActionType {
-    // (undocumented)
     Internal = "Internal"
 }
 
 // @public
 export enum KnownCreatedByType {
-    // (undocumented)
     Application = "Application",
-    // (undocumented)
     Key = "Key",
-    // (undocumented)
     ManagedIdentity = "ManagedIdentity",
-    // (undocumented)
     User = "User"
 }
 
 // @public
 export enum KnownGrantStatus {
-    // (undocumented)
     Active = "Active",
-    // (undocumented)
     Inactive = "Inactive"
 }
 
 // @public
 export enum KnownGrantType {
-    // (undocumented)
     Academic = "Academic",
-    // (undocumented)
     Student = "Student"
 }
 
 // @public
 export enum KnownJoinRequestStatus {
-    // (undocumented)
     Denied = "Denied",
-    // (undocumented)
     Pending = "Pending"
 }
 
 // @public
 export enum KnownLabStatus {
-    // (undocumented)
     Active = "Active",
-    // (undocumented)
-    Deleted = "Deleted"
+    Deleted = "Deleted",
+    Pending = "Pending"
 }
 
 // @public
 export enum KnownOrigin {
-    // (undocumented)
     System = "system",
-    // (undocumented)
     User = "user",
-    // (undocumented)
     UserSystem = "user,system"
 }
 
 // @public
 export enum KnownStudentLabStatus {
-    // (undocumented)
     Active = "Active",
-    // (undocumented)
     Deleted = "Deleted",
-    // (undocumented)
     Disabled = "Disabled",
-    // (undocumented)
     Expired = "Expired",
-    // (undocumented)
     Pending = "Pending"
 }
 
 // @public
 export enum KnownStudentRole {
-    // (undocumented)
     Admin = "Admin",
-    // (undocumented)
     Student = "Student"
 }
 
 // @public
-export type LabDetails = Resource & {
-    displayName?: string;
+export interface LabDetails extends Resource {
     budgetPerStudent?: Amount;
+    currencyPropertiesTotalAllocatedBudgetCurrency?: string;
+    currencyPropertiesTotalBudgetCurrency?: string;
     description?: string;
-    expirationDate?: Date;
+    displayName?: string;
     readonly effectiveDate?: Date;
-    readonly status?: LabStatus;
-    readonly maxStudentCount?: number;
+    expirationDate?: Date;
     readonly invitationCode?: string;
-    currencyPropertiesTotalAllocatedBudgetCurrency?: string;
+    readonly maxStudentCount?: number;
+    readonly status?: LabStatus;
     valuePropertiesTotalAllocatedBudgetValue?: number;
-    currencyPropertiesTotalBudgetCurrency?: string;
     valuePropertiesTotalBudgetValue?: number;
-};
+}
 
 // @public
 export interface LabListResult {
@@ -333,8 +311,6 @@ export type LabsGetResponse = LabDetails;
 
 // @public
 export interface LabsListAllNextOptionalParams extends coreClient.OperationOptions {
-    includeBudget?: boolean;
-    includeDeleted?: boolean;
 }
 
 // @public
@@ -351,7 +327,6 @@ export type LabsListAllResponse = LabListResult;
 
 // @public
 export interface LabsListNextOptionalParams extends coreClient.OperationOptions {
-    includeBudget?: boolean;
 }
 
 // @public
@@ -426,32 +401,32 @@ export interface Resource {
 }
 
 // @public
-export type StudentDetails = Resource & {
+export interface StudentDetails extends Resource {
+    budget?: Amount;
+    readonly effectiveDate?: Date;
+    email?: string;
+    expirationDate?: Date;
     firstName?: string;
     lastName?: string;
-    email?: string;
     role?: StudentRole;
-    budget?: Amount;
-    readonly subscriptionId?: string;
-    expirationDate?: Date;
     readonly status?: StudentLabStatus;
-    readonly effectiveDate?: Date;
     subscriptionAlias?: string;
+    readonly subscriptionId?: string;
     subscriptionInviteLastSentDate?: Date;
-};
+}
 
 // @public
-export type StudentLabDetails = Resource & {
-    readonly displayName?: string;
+export interface StudentLabDetails extends Resource {
+    readonly budget?: Amount;
     readonly description?: string;
+    readonly displayName?: string;
+    readonly effectiveDate?: Date;
     readonly expirationDate?: Date;
+    readonly labScope?: string;
     readonly role?: StudentRole;
-    readonly budget?: Amount;
-    readonly subscriptionId?: string;
     readonly status?: StudentLabStatus;
-    readonly effectiveDate?: Date;
-    readonly labScope?: string;
-};
+    readonly subscriptionId?: string;
+}
 
 // @public
 export interface StudentLabListResult {
@@ -526,7 +501,6 @@ export type StudentsGetResponse = StudentDetails;
 
 // @public
 export interface StudentsListNextOptionalParams extends coreClient.OperationOptions {
-    includeDeleted?: boolean;
 }
 
 // @public

package/src/educationManagementClient.ts

@@ -8,6 +8,11 @@
 
 import * as coreClient from "@azure/core-client";
 import * as coreRestPipeline from "@azure/core-rest-pipeline";
+import {
+  PipelineRequest,
+  PipelineResponse,
+  SendRequest
+} from "@azure/core-rest-pipeline";
 import * as coreAuth from "@azure/core-auth";
 import {
   OperationsImpl,
@@ -59,47 +64,53 @@ export class EducationManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-education/1.0.0-beta.1`;
+    const packageDetails = `azsdk-js-arm-education/1.0.0-beta.3`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
         : `${packageDetails}`;
 
-    if (!options.credentialScopes) {
-      options.credentialScopes = ["https://management.azure.com/.default"];
-    }
     const optionsWithDefaults = {
       ...defaults,
       ...options,
       userAgentOptions: {
         userAgentPrefix
       },
-      baseUri:
+      endpoint:
         options.endpoint ?? options.baseUri ?? "https://management.azure.com"
     };
     super(optionsWithDefaults);
 
+    let bearerTokenAuthenticationPolicyFound: boolean = false;
     if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
       const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
-      const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
         (pipelinePolicy) =>
           pipelinePolicy.name ===
           coreRestPipeline.bearerTokenAuthenticationPolicyName
       );
-      if (!bearerTokenAuthenticationPolicyFound) {
-        this.pipeline.removePolicy({
-          name: coreRestPipeline.bearerTokenAuthenticationPolicyName
-        });
-        this.pipeline.addPolicy(
-          coreRestPipeline.bearerTokenAuthenticationPolicy({
-            scopes: `${optionsWithDefaults.baseUri}/.default`,
-            challengeCallbacks: {
-              authorizeRequestOnChallenge:
-                coreClient.authorizeRequestOnClaimChallenge
-            }
-          })
-        );
-      }
+    }
+    if (
+      !options ||
+      !options.pipeline ||
+      options.pipeline.getOrderedPolicies().length == 0 ||
+      !bearerTokenAuthenticationPolicyFound
+    ) {
+      this.pipeline.removePolicy({
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+      });
+      this.pipeline.addPolicy(
+        coreRestPipeline.bearerTokenAuthenticationPolicy({
+          credential: credentials,
+          scopes:
+            optionsWithDefaults.credentialScopes ??
+            `${optionsWithDefaults.endpoint}/.default`,
+          challengeCallbacks: {
+            authorizeRequestOnChallenge:
+              coreClient.authorizeRequestOnClaimChallenge
+          }
+        })
+      );
     }
 
     // Assigning values to Constant parameters
@@ -111,6 +122,35 @@ export class EducationManagementClient extends coreClient.ServiceClient {
     this.joinRequests = new JoinRequestsImpl(this);
     this.students = new StudentsImpl(this);
     this.studentLabs = new StudentLabsImpl(this);
+    this.addCustomApiVersionPolicy(options.apiVersion);
+  }
+
+  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+  private addCustomApiVersionPolicy(apiVersion?: string) {
+    if (!apiVersion) {
+      return;
+    }
+    const apiVersionPolicy = {
+      name: "CustomApiVersionPolicy",
+      async sendRequest(
+        request: PipelineRequest,
+        next: SendRequest
+      ): Promise<PipelineResponse> {
+        const param = request.url.split("?");
+        if (param.length > 1) {
+          const newParams = param[1].split("&").map((item) => {
+            if (item.indexOf("api-version") > -1) {
+              return "api-version=" + apiVersion;
+            } else {
+              return item;
+            }
+          });
+          request.url = param[0] + "?" + newParams.join("&");
+        }
+        return next(request);
+      }
+    };
+    this.pipeline.addPolicy(apiVersionPolicy);
   }
 
   /**

package/src/index.ts

@@ -7,6 +7,7 @@
  */
 
 /// <reference lib="esnext.asynciterable" />
+export { getContinuationToken } from "./pagingHelper";
 export * from "./models";
 export { EducationManagementClient } from "./educationManagementClient";
 export * from "./operationsInterfaces";

package/src/models/index.ts

@@ -221,7 +221,7 @@ export interface StudentLabListResult {
 }
 
 /** Grant details. */
-export type GrantDetails = Resource & {
+export interface GrantDetails extends Resource {
   /**
    * Offer Cap
    * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -252,10 +252,10 @@ export type GrantDetails = Resource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly allocatedBudget?: Amount;
-};
+}
 
 /** Lab details. */
-export type LabDetails = Resource & {
+export interface LabDetails extends Resource {
   /** Lab Display Name */
   displayName?: string;
   /** Default monetary cap for each student in this lab */
@@ -292,10 +292,10 @@ export type LabDetails = Resource & {
   currencyPropertiesTotalBudgetCurrency?: string;
   /** Amount value. */
   valuePropertiesTotalBudgetValue?: number;
-};
+}
 
 /** join requests. */
-export type JoinRequestDetails = Resource & {
+export interface JoinRequestDetails extends Resource {
   /** First Name */
   firstName?: string;
   /** Last Name */
@@ -304,10 +304,10 @@ export type JoinRequestDetails = Resource & {
   email?: string;
   /** Join request status */
   status?: JoinRequestStatus;
-};
+}
 
 /** Student details. */
-export type StudentDetails = Resource & {
+export interface StudentDetails extends Resource {
   /** First Name */
   firstName?: string;
   /** Last Name */
@@ -339,10 +339,10 @@ export type StudentDetails = Resource & {
   subscriptionAlias?: string;
   /** subscription invite last sent date */
   subscriptionInviteLastSentDate?: Date;
-};
+}
 
 /** Student lab details. */
-export type StudentLabDetails = Resource & {
+export interface StudentLabDetails extends Resource {
   /**
    * Student lab Display Name
    * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -388,12 +388,15 @@ export type StudentLabDetails = Resource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly labScope?: string;
-};
+}
 
 /** Known values of {@link Origin} that the service accepts. */
 export enum KnownOrigin {
+  /** User */
   User = "user",
+  /** System */
   System = "system",
+  /** UserSystem */
   UserSystem = "user,system"
 }
 
@@ -410,6 +413,7 @@ export type Origin = string;
 
 /** Known values of {@link ActionType} that the service accepts. */
 export enum KnownActionType {
+  /** Internal */
   Internal = "Internal"
 }
 
@@ -424,7 +428,9 @@ export type ActionType = string;
 
 /** Known values of {@link GrantType} that the service accepts. */
 export enum KnownGrantType {
+  /** Student */
   Student = "Student",
+  /** Academic */
   Academic = "Academic"
 }
 
@@ -440,7 +446,9 @@ export type GrantType = string;
 
 /** Known values of {@link GrantStatus} that the service accepts. */
 export enum KnownGrantStatus {
+  /** Active */
   Active = "Active",
+  /** Inactive */
   Inactive = "Inactive"
 }
 
@@ -456,9 +464,13 @@ export type GrantStatus = string;
 
 /** Known values of {@link CreatedByType} that the service accepts. */
 export enum KnownCreatedByType {
+  /** User */
   User = "User",
+  /** Application */
   Application = "Application",
+  /** ManagedIdentity */
   ManagedIdentity = "ManagedIdentity",
+  /** Key */
   Key = "Key"
 }
 
@@ -476,8 +488,12 @@ export type CreatedByType = string;
 
 /** Known values of {@link LabStatus} that the service accepts. */
 export enum KnownLabStatus {
+  /** Active */
   Active = "Active",
-  Deleted = "Deleted"
+  /** Deleted */
+  Deleted = "Deleted",
+  /** Pending */
+  Pending = "Pending"
 }
 
 /**
@@ -486,13 +502,16 @@ export enum KnownLabStatus {
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
  * **Active** \
- * **Deleted**
+ * **Deleted** \
+ * **Pending**
  */
 export type LabStatus = string;
 
 /** Known values of {@link JoinRequestStatus} that the service accepts. */
 export enum KnownJoinRequestStatus {
+  /** Pending */
   Pending = "Pending",
+  /** Denied */
   Denied = "Denied"
 }
 
@@ -508,7 +527,9 @@ export type JoinRequestStatus = string;
 
 /** Known values of {@link StudentRole} that the service accepts. */
 export enum KnownStudentRole {
+  /** Student */
   Student = "Student",
+  /** Admin */
   Admin = "Admin"
 }
 
@@ -524,10 +545,15 @@ export type StudentRole = string;
 
 /** Known values of {@link StudentLabStatus} that the service accepts. */
 export enum KnownStudentLabStatus {
+  /** Active */
   Active = "Active",
+  /** Disabled */
   Disabled = "Disabled",
+  /** Expired */
   Expired = "Expired",
+  /** Pending */
   Pending = "Pending",
+  /** Deleted */
   Deleted = "Deleted"
 }
 
@@ -581,20 +607,14 @@ export type GrantsGetResponse = GrantDetails;
 
 /** Optional parameters. */
 export interface GrantsListAllNextOptionalParams
-  extends coreClient.OperationOptions {
-  /** May be used to include information about budget that has been allocated. */
-  includeAllocatedBudget?: boolean;
-}
+  extends coreClient.OperationOptions {}
 
 /** Contains response data for the listAllNext operation. */
 export type GrantsListAllNextResponse = GrantListResponse;
 
 /** Optional parameters. */
 export interface GrantsListNextOptionalParams
-  extends coreClient.OperationOptions {
-  /** May be used to include information about budget that has been allocated. */
-  includeAllocatedBudget?: boolean;
-}
+  extends coreClient.OperationOptions {}
 
 /** Contains response data for the listNext operation. */
 export type GrantsListNextResponse = GrantListResponse;
@@ -650,22 +670,14 @@ export type LabsGenerateInviteCodeResponse = LabDetails;
 
 /** Optional parameters. */
 export interface LabsListAllNextOptionalParams
-  extends coreClient.OperationOptions {
-  /** May be used to include budget information. */
-  includeBudget?: boolean;
-  /** May be used to show deleted items. */
-  includeDeleted?: boolean;
-}
+  extends coreClient.OperationOptions {}
 
 /** Contains response data for the listAllNext operation. */
 export type LabsListAllNextResponse = LabListResult;
 
 /** Optional parameters. */
 export interface LabsListNextOptionalParams
-  extends coreClient.OperationOptions {
-  /** May be used to include budget information. */
-  includeBudget?: boolean;
-}
+  extends coreClient.OperationOptions {}
 
 /** Contains response data for the listNext operation. */
 export type LabsListNextResponse = LabListResult;
@@ -697,10 +709,7 @@ export interface JoinRequestsDenyOptionalParams
 
 /** Optional parameters. */
 export interface JoinRequestsListNextOptionalParams
-  extends coreClient.OperationOptions {
-  /** Include denied */
-  includeDenied?: boolean;
-}
+  extends coreClient.OperationOptions {}
 
 /** Contains response data for the listNext operation. */
 export type JoinRequestsListNextResponse = JoinRequestList;
@@ -739,10 +748,7 @@ export type StudentsCreateOrUpdateResponse = StudentDetails;
 
 /** Optional parameters. */
 export interface StudentsListNextOptionalParams
-  extends coreClient.OperationOptions {
-  /** May be used to show deleted items. */
-  includeDeleted?: boolean;
-}
+  extends coreClient.OperationOptions {}
 
 /** Contains response data for the listNext operation. */
 export type StudentsListNextResponse = StudentListResult;