@azure/arm-education 1.0.0-beta.1 → 1.0.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -0
- package/LICENSE +1 -1
- package/README.md +4 -3
- package/dist/index.js +233 -79
- package/dist/index.js.map +1 -1
- package/dist/index.min.js +1 -1
- package/dist/index.min.js.map +1 -1
- package/dist-esm/samples-dev/grantsGetSample.js +9 -2
- package/dist-esm/samples-dev/grantsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/grantsListAllSample.js +9 -2
- package/dist-esm/samples-dev/grantsListAllSample.js.map +1 -1
- package/dist-esm/samples-dev/grantsListSample.js +9 -2
- package/dist-esm/samples-dev/grantsListSample.js.map +1 -1
- package/dist-esm/samples-dev/joinRequestsApproveSample.js +8 -1
- package/dist-esm/samples-dev/joinRequestsApproveSample.js.map +1 -1
- package/dist-esm/samples-dev/joinRequestsDenySample.js +8 -1
- package/dist-esm/samples-dev/joinRequestsDenySample.js.map +1 -1
- package/dist-esm/samples-dev/joinRequestsGetSample.js +8 -1
- package/dist-esm/samples-dev/joinRequestsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/joinRequestsListSample.js +8 -1
- package/dist-esm/samples-dev/joinRequestsListSample.js.map +1 -1
- package/dist-esm/samples-dev/labsCreateOrUpdateSample.js +8 -1
- package/dist-esm/samples-dev/labsCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/labsDeleteSample.js +8 -1
- package/dist-esm/samples-dev/labsDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/labsGenerateInviteCodeSample.js +8 -1
- package/dist-esm/samples-dev/labsGenerateInviteCodeSample.js.map +1 -1
- package/dist-esm/samples-dev/labsGetSample.js +9 -2
- package/dist-esm/samples-dev/labsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/labsListAllSample.js +9 -2
- package/dist-esm/samples-dev/labsListAllSample.js.map +1 -1
- package/dist-esm/samples-dev/labsListSample.js +9 -2
- package/dist-esm/samples-dev/labsListSample.js.map +1 -1
- package/dist-esm/samples-dev/operationsListSample.js +8 -1
- package/dist-esm/samples-dev/operationsListSample.js.map +1 -1
- package/dist-esm/samples-dev/redeemInvitationCodeSample.js +8 -1
- package/dist-esm/samples-dev/redeemInvitationCodeSample.js.map +1 -1
- package/dist-esm/samples-dev/studentLabsGetSample.js +8 -1
- package/dist-esm/samples-dev/studentLabsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/studentLabsListAllSample.js +8 -1
- package/dist-esm/samples-dev/studentLabsListAllSample.js.map +1 -1
- package/dist-esm/samples-dev/studentsCreateOrUpdateSample.js +8 -1
- package/dist-esm/samples-dev/studentsCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/studentsDeleteSample.js +8 -1
- package/dist-esm/samples-dev/studentsDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/studentsGetSample.js +8 -1
- package/dist-esm/samples-dev/studentsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/studentsListSample.js +8 -1
- package/dist-esm/samples-dev/studentsListSample.js.map +1 -1
- package/dist-esm/src/educationManagementClient.d.ts +2 -0
- package/dist-esm/src/educationManagementClient.d.ts.map +1 -1
- package/dist-esm/src/educationManagementClient.js +49 -18
- package/dist-esm/src/educationManagementClient.js.map +1 -1
- package/dist-esm/src/index.d.ts +1 -0
- package/dist-esm/src/index.d.ts.map +1 -1
- package/dist-esm/src/index.js +1 -0
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/models/index.d.ts +38 -26
- package/dist-esm/src/models/index.d.ts.map +1 -1
- package/dist-esm/src/models/index.js +25 -0
- package/dist-esm/src/models/index.js.map +1 -1
- package/dist-esm/src/operations/grants.d.ts.map +1 -1
- package/dist-esm/src/operations/grants.js +37 -16
- package/dist-esm/src/operations/grants.js.map +1 -1
- package/dist-esm/src/operations/joinRequests.d.ts.map +1 -1
- package/dist-esm/src/operations/joinRequests.js +19 -8
- package/dist-esm/src/operations/joinRequests.js.map +1 -1
- package/dist-esm/src/operations/labs.d.ts.map +1 -1
- package/dist-esm/src/operations/labs.js +37 -20
- package/dist-esm/src/operations/labs.js.map +1 -1
- package/dist-esm/src/operations/studentLabs.d.ts.map +1 -1
- package/dist-esm/src/operations/studentLabs.js +19 -8
- package/dist-esm/src/operations/studentLabs.js.map +1 -1
- package/dist-esm/src/operations/students.d.ts.map +1 -1
- package/dist-esm/src/operations/students.js +19 -8
- package/dist-esm/src/operations/students.js.map +1 -1
- package/dist-esm/src/pagingHelper.d.ts +13 -0
- package/dist-esm/src/pagingHelper.d.ts.map +1 -0
- package/dist-esm/src/pagingHelper.js +32 -0
- package/dist-esm/src/pagingHelper.js.map +1 -0
- package/dist-esm/test/sampleTest.js +11 -13
- package/dist-esm/test/sampleTest.js.map +1 -1
- package/package.json +17 -12
- package/review/arm-education.api.md +35 -61
- package/src/educationManagementClient.ts +60 -20
- package/src/index.ts +1 -0
- package/src/models/index.ts +44 -38
- package/src/operations/grants.ts +46 -22
- package/src/operations/joinRequests.ts +27 -14
- package/src/operations/labs.ts +52 -31
- package/src/operations/studentLabs.ts +21 -9
- package/src/operations/students.ts +27 -14
- package/src/pagingHelper.ts +39 -0
- package/types/arm-education.d.ts +49 -26
- package/types/tsdoc-metadata.json +1 -1
package/types/arm-education.d.ts
CHANGED
|
@@ -40,6 +40,8 @@ export declare class EducationManagementClient extends coreClient.ServiceClient
|
|
|
40
40
|
* @param options The parameter options
|
|
41
41
|
*/
|
|
42
42
|
constructor(credentials: coreAuth.TokenCredential, options?: EducationManagementClientOptionalParams);
|
|
43
|
+
/** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
|
|
44
|
+
private addCustomApiVersionPolicy;
|
|
43
45
|
/**
|
|
44
46
|
* Redeem invite code to join a redeemable lab
|
|
45
47
|
* @param parameters Request parameters to provide redeem code.
|
|
@@ -78,8 +80,17 @@ export declare interface ErrorResponseBody {
|
|
|
78
80
|
error?: ErrorResponse;
|
|
79
81
|
}
|
|
80
82
|
|
|
83
|
+
/**
|
|
84
|
+
* Given the last `.value` produced by the `byPage` iterator,
|
|
85
|
+
* returns a continuation token that can be used to begin paging from
|
|
86
|
+
* that point later.
|
|
87
|
+
* @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
|
|
88
|
+
* @returns The continuation token that can be passed into byPage() during future calls.
|
|
89
|
+
*/
|
|
90
|
+
export declare function getContinuationToken(page: unknown): string | undefined;
|
|
91
|
+
|
|
81
92
|
/** Grant details. */
|
|
82
|
-
export declare
|
|
93
|
+
export declare interface GrantDetails extends Resource {
|
|
83
94
|
/**
|
|
84
95
|
* Offer Cap
|
|
85
96
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -110,7 +121,7 @@ export declare type GrantDetails = Resource & {
|
|
|
110
121
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
111
122
|
*/
|
|
112
123
|
readonly allocatedBudget?: Amount;
|
|
113
|
-
}
|
|
124
|
+
}
|
|
114
125
|
|
|
115
126
|
/** List of Grants info. */
|
|
116
127
|
export declare interface GrantListResponse {
|
|
@@ -160,8 +171,6 @@ export declare type GrantsGetResponse = GrantDetails;
|
|
|
160
171
|
|
|
161
172
|
/** Optional parameters. */
|
|
162
173
|
export declare interface GrantsListAllNextOptionalParams extends coreClient.OperationOptions {
|
|
163
|
-
/** May be used to include information about budget that has been allocated. */
|
|
164
|
-
includeAllocatedBudget?: boolean;
|
|
165
174
|
}
|
|
166
175
|
|
|
167
176
|
/** Contains response data for the listAllNext operation. */
|
|
@@ -178,8 +187,6 @@ export declare type GrantsListAllResponse = GrantListResponse;
|
|
|
178
187
|
|
|
179
188
|
/** Optional parameters. */
|
|
180
189
|
export declare interface GrantsListNextOptionalParams extends coreClient.OperationOptions {
|
|
181
|
-
/** May be used to include information about budget that has been allocated. */
|
|
182
|
-
includeAllocatedBudget?: boolean;
|
|
183
190
|
}
|
|
184
191
|
|
|
185
192
|
/** Contains response data for the listNext operation. */
|
|
@@ -221,7 +228,7 @@ export declare interface InviteCodeGenerateRequest {
|
|
|
221
228
|
}
|
|
222
229
|
|
|
223
230
|
/** join requests. */
|
|
224
|
-
export declare
|
|
231
|
+
export declare interface JoinRequestDetails extends Resource {
|
|
225
232
|
/** First Name */
|
|
226
233
|
firstName?: string;
|
|
227
234
|
/** Last Name */
|
|
@@ -230,7 +237,7 @@ export declare type JoinRequestDetails = Resource & {
|
|
|
230
237
|
email?: string;
|
|
231
238
|
/** Join request status */
|
|
232
239
|
status?: JoinRequestStatus;
|
|
233
|
-
}
|
|
240
|
+
}
|
|
234
241
|
|
|
235
242
|
/** list of join requests. */
|
|
236
243
|
export declare interface JoinRequestList {
|
|
@@ -302,8 +309,6 @@ export declare type JoinRequestsGetResponse = JoinRequestDetails;
|
|
|
302
309
|
|
|
303
310
|
/** Optional parameters. */
|
|
304
311
|
export declare interface JoinRequestsListNextOptionalParams extends coreClient.OperationOptions {
|
|
305
|
-
/** Include denied */
|
|
306
|
-
includeDenied?: boolean;
|
|
307
312
|
}
|
|
308
313
|
|
|
309
314
|
/** Contains response data for the listNext operation. */
|
|
@@ -330,65 +335,90 @@ export declare type JoinRequestStatus = string;
|
|
|
330
335
|
|
|
331
336
|
/** Known values of {@link ActionType} that the service accepts. */
|
|
332
337
|
export declare enum KnownActionType {
|
|
338
|
+
/** Internal */
|
|
333
339
|
Internal = "Internal"
|
|
334
340
|
}
|
|
335
341
|
|
|
336
342
|
/** Known values of {@link CreatedByType} that the service accepts. */
|
|
337
343
|
export declare enum KnownCreatedByType {
|
|
344
|
+
/** User */
|
|
338
345
|
User = "User",
|
|
346
|
+
/** Application */
|
|
339
347
|
Application = "Application",
|
|
348
|
+
/** ManagedIdentity */
|
|
340
349
|
ManagedIdentity = "ManagedIdentity",
|
|
350
|
+
/** Key */
|
|
341
351
|
Key = "Key"
|
|
342
352
|
}
|
|
343
353
|
|
|
344
354
|
/** Known values of {@link GrantStatus} that the service accepts. */
|
|
345
355
|
export declare enum KnownGrantStatus {
|
|
356
|
+
/** Active */
|
|
346
357
|
Active = "Active",
|
|
358
|
+
/** Inactive */
|
|
347
359
|
Inactive = "Inactive"
|
|
348
360
|
}
|
|
349
361
|
|
|
350
362
|
/** Known values of {@link GrantType} that the service accepts. */
|
|
351
363
|
export declare enum KnownGrantType {
|
|
364
|
+
/** Student */
|
|
352
365
|
Student = "Student",
|
|
366
|
+
/** Academic */
|
|
353
367
|
Academic = "Academic"
|
|
354
368
|
}
|
|
355
369
|
|
|
356
370
|
/** Known values of {@link JoinRequestStatus} that the service accepts. */
|
|
357
371
|
export declare enum KnownJoinRequestStatus {
|
|
372
|
+
/** Pending */
|
|
358
373
|
Pending = "Pending",
|
|
374
|
+
/** Denied */
|
|
359
375
|
Denied = "Denied"
|
|
360
376
|
}
|
|
361
377
|
|
|
362
378
|
/** Known values of {@link LabStatus} that the service accepts. */
|
|
363
379
|
export declare enum KnownLabStatus {
|
|
380
|
+
/** Active */
|
|
364
381
|
Active = "Active",
|
|
365
|
-
Deleted
|
|
382
|
+
/** Deleted */
|
|
383
|
+
Deleted = "Deleted",
|
|
384
|
+
/** Pending */
|
|
385
|
+
Pending = "Pending"
|
|
366
386
|
}
|
|
367
387
|
|
|
368
388
|
/** Known values of {@link Origin} that the service accepts. */
|
|
369
389
|
export declare enum KnownOrigin {
|
|
390
|
+
/** User */
|
|
370
391
|
User = "user",
|
|
392
|
+
/** System */
|
|
371
393
|
System = "system",
|
|
394
|
+
/** UserSystem */
|
|
372
395
|
UserSystem = "user,system"
|
|
373
396
|
}
|
|
374
397
|
|
|
375
398
|
/** Known values of {@link StudentLabStatus} that the service accepts. */
|
|
376
399
|
export declare enum KnownStudentLabStatus {
|
|
400
|
+
/** Active */
|
|
377
401
|
Active = "Active",
|
|
402
|
+
/** Disabled */
|
|
378
403
|
Disabled = "Disabled",
|
|
404
|
+
/** Expired */
|
|
379
405
|
Expired = "Expired",
|
|
406
|
+
/** Pending */
|
|
380
407
|
Pending = "Pending",
|
|
408
|
+
/** Deleted */
|
|
381
409
|
Deleted = "Deleted"
|
|
382
410
|
}
|
|
383
411
|
|
|
384
412
|
/** Known values of {@link StudentRole} that the service accepts. */
|
|
385
413
|
export declare enum KnownStudentRole {
|
|
414
|
+
/** Student */
|
|
386
415
|
Student = "Student",
|
|
416
|
+
/** Admin */
|
|
387
417
|
Admin = "Admin"
|
|
388
418
|
}
|
|
389
419
|
|
|
390
420
|
/** Lab details. */
|
|
391
|
-
export declare
|
|
421
|
+
export declare interface LabDetails extends Resource {
|
|
392
422
|
/** Lab Display Name */
|
|
393
423
|
displayName?: string;
|
|
394
424
|
/** Default monetary cap for each student in this lab */
|
|
@@ -425,7 +455,7 @@ export declare type LabDetails = Resource & {
|
|
|
425
455
|
currencyPropertiesTotalBudgetCurrency?: string;
|
|
426
456
|
/** Amount value. */
|
|
427
457
|
valuePropertiesTotalBudgetValue?: number;
|
|
428
|
-
}
|
|
458
|
+
}
|
|
429
459
|
|
|
430
460
|
/** List of labs. */
|
|
431
461
|
export declare interface LabListResult {
|
|
@@ -528,10 +558,6 @@ export declare type LabsGetResponse = LabDetails;
|
|
|
528
558
|
|
|
529
559
|
/** Optional parameters. */
|
|
530
560
|
export declare interface LabsListAllNextOptionalParams extends coreClient.OperationOptions {
|
|
531
|
-
/** May be used to include budget information. */
|
|
532
|
-
includeBudget?: boolean;
|
|
533
|
-
/** May be used to show deleted items. */
|
|
534
|
-
includeDeleted?: boolean;
|
|
535
561
|
}
|
|
536
562
|
|
|
537
563
|
/** Contains response data for the listAllNext operation. */
|
|
@@ -550,8 +576,6 @@ export declare type LabsListAllResponse = LabListResult;
|
|
|
550
576
|
|
|
551
577
|
/** Optional parameters. */
|
|
552
578
|
export declare interface LabsListNextOptionalParams extends coreClient.OperationOptions {
|
|
553
|
-
/** May be used to include budget information. */
|
|
554
|
-
includeBudget?: boolean;
|
|
555
579
|
}
|
|
556
580
|
|
|
557
581
|
/** Contains response data for the listNext operation. */
|
|
@@ -572,7 +596,8 @@ export declare type LabsListResponse = LabListResult;
|
|
|
572
596
|
* this enum contains the known values that the service supports.
|
|
573
597
|
* ### Known values supported by the service
|
|
574
598
|
* **Active** \
|
|
575
|
-
* **Deleted**
|
|
599
|
+
* **Deleted** \
|
|
600
|
+
* **Pending**
|
|
576
601
|
*/
|
|
577
602
|
export declare type LabStatus = string;
|
|
578
603
|
|
|
@@ -706,7 +731,7 @@ export declare interface Resource {
|
|
|
706
731
|
}
|
|
707
732
|
|
|
708
733
|
/** Student details. */
|
|
709
|
-
export declare
|
|
734
|
+
export declare interface StudentDetails extends Resource {
|
|
710
735
|
/** First Name */
|
|
711
736
|
firstName?: string;
|
|
712
737
|
/** Last Name */
|
|
@@ -738,10 +763,10 @@ export declare type StudentDetails = Resource & {
|
|
|
738
763
|
subscriptionAlias?: string;
|
|
739
764
|
/** subscription invite last sent date */
|
|
740
765
|
subscriptionInviteLastSentDate?: Date;
|
|
741
|
-
}
|
|
766
|
+
}
|
|
742
767
|
|
|
743
768
|
/** Student lab details. */
|
|
744
|
-
export declare
|
|
769
|
+
export declare interface StudentLabDetails extends Resource {
|
|
745
770
|
/**
|
|
746
771
|
* Student lab Display Name
|
|
747
772
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -787,7 +812,7 @@ export declare type StudentLabDetails = Resource & {
|
|
|
787
812
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
788
813
|
*/
|
|
789
814
|
readonly labScope?: string;
|
|
790
|
-
}
|
|
815
|
+
}
|
|
791
816
|
|
|
792
817
|
/** List of labs. */
|
|
793
818
|
export declare interface StudentLabListResult {
|
|
@@ -937,8 +962,6 @@ export declare type StudentsGetResponse = StudentDetails;
|
|
|
937
962
|
|
|
938
963
|
/** Optional parameters. */
|
|
939
964
|
export declare interface StudentsListNextOptionalParams extends coreClient.OperationOptions {
|
|
940
|
-
/** May be used to show deleted items. */
|
|
941
|
-
includeDeleted?: boolean;
|
|
942
965
|
}
|
|
943
966
|
|
|
944
967
|
/** Contains response data for the listNext operation. */
|