@maxim_mazurok/gapi.client.cloudresourcemanager-v2beta1 0.1.20260310 → 0.2.20260521
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/index.d.ts +60 -42
- package/package.json +1 -1
- package/readme.md +17 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v2beta1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260521
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -41,7 +41,11 @@ declare namespace gapi.client {
|
|
|
41
41
|
/** Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */
|
|
42
42
|
exemptedMembers?: string[];
|
|
43
43
|
/** The log type that this config enables. */
|
|
44
|
-
logType?:
|
|
44
|
+
logType?:
|
|
45
|
+
| 'LOG_TYPE_UNSPECIFIED'
|
|
46
|
+
| 'ADMIN_READ'
|
|
47
|
+
| 'DATA_WRITE'
|
|
48
|
+
| 'DATA_READ';
|
|
45
49
|
}
|
|
46
50
|
interface Binding {
|
|
47
51
|
/** The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */
|
|
@@ -57,7 +61,7 @@ declare namespace gapi.client {
|
|
|
57
61
|
/** The display name of the folder. */
|
|
58
62
|
displayName?: string;
|
|
59
63
|
/** The type of this operation. */
|
|
60
|
-
operationType?:
|
|
64
|
+
operationType?: 'OPERATION_TYPE_UNSPECIFIED' | 'CREATE' | 'MOVE';
|
|
61
65
|
/** The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */
|
|
62
66
|
sourceParent?: string;
|
|
63
67
|
}
|
|
@@ -67,7 +71,7 @@ declare namespace gapi.client {
|
|
|
67
71
|
/** The display name of the folder. */
|
|
68
72
|
displayName?: string;
|
|
69
73
|
/** The type of this operation. */
|
|
70
|
-
operationType?:
|
|
74
|
+
operationType?: 'OPERATION_TYPE_UNSPECIFIED' | 'CREATE' | 'MOVE';
|
|
71
75
|
/** The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */
|
|
72
76
|
sourceParent?: string;
|
|
73
77
|
}
|
|
@@ -112,7 +116,10 @@ declare namespace gapi.client {
|
|
|
112
116
|
/** The folder's display name. A folder's display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: `[\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?`. */
|
|
113
117
|
displayName?: string;
|
|
114
118
|
/** Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. */
|
|
115
|
-
lifecycleState?:
|
|
119
|
+
lifecycleState?:
|
|
120
|
+
| 'LIFECYCLE_STATE_UNSPECIFIED'
|
|
121
|
+
| 'ACTIVE'
|
|
122
|
+
| 'DELETE_REQUESTED';
|
|
116
123
|
/** Output only. Management Project associated with this folder (if app-management capability is enabled). Example: `projects/google-mp-123` OUTPUT ONLY. */
|
|
117
124
|
managementProject?: string;
|
|
118
125
|
/** Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */
|
|
@@ -128,13 +135,24 @@ declare namespace gapi.client {
|
|
|
128
135
|
/** The display name of the folder. */
|
|
129
136
|
displayName?: string;
|
|
130
137
|
/** The type of this operation. */
|
|
131
|
-
operationType?:
|
|
138
|
+
operationType?: 'OPERATION_TYPE_UNSPECIFIED' | 'CREATE' | 'MOVE';
|
|
132
139
|
/** The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */
|
|
133
140
|
sourceParent?: string;
|
|
134
141
|
}
|
|
135
142
|
interface FolderOperationError {
|
|
136
143
|
/** The type of operation error experienced. */
|
|
137
|
-
errorMessageId?:
|
|
144
|
+
errorMessageId?:
|
|
145
|
+
| 'ERROR_TYPE_UNSPECIFIED'
|
|
146
|
+
| 'ACTIVE_FOLDER_HEIGHT_VIOLATION'
|
|
147
|
+
| 'MAX_CHILD_FOLDERS_VIOLATION'
|
|
148
|
+
| 'FOLDER_NAME_UNIQUENESS_VIOLATION'
|
|
149
|
+
| 'RESOURCE_DELETED_VIOLATION'
|
|
150
|
+
| 'PARENT_DELETED_VIOLATION'
|
|
151
|
+
| 'CYCLE_INTRODUCED_VIOLATION'
|
|
152
|
+
| 'FOLDER_BEING_MOVED_VIOLATION'
|
|
153
|
+
| 'FOLDER_TO_DELETE_NON_EMPTY_VIOLATION'
|
|
154
|
+
| 'DELETED_FOLDER_HEIGHT_VIOLATION'
|
|
155
|
+
| 'FOLDER_TO_DELETE_CONFIGURED_CAPABILITY_VIOLATION';
|
|
138
156
|
}
|
|
139
157
|
interface GetIamPolicyRequest {
|
|
140
158
|
/** OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */
|
|
@@ -217,7 +235,7 @@ declare namespace gapi.client {
|
|
|
217
235
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
218
236
|
code?: number;
|
|
219
237
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
220
|
-
details?:
|
|
238
|
+
details?: {[P in string]: any}[];
|
|
221
239
|
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
222
240
|
message?: string;
|
|
223
241
|
}
|
|
@@ -241,11 +259,11 @@ declare namespace gapi.client {
|
|
|
241
259
|
/** Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder. In order to succeed, the addition of this new Folder must not violate the Folder naming, height or fanout constraints. + The Folder's display_name must be distinct from all other Folders that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 10. Note, the full active + deleted Folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders. + The addition of the Folder must not cause the total number of Folders under its parent to exceed 300. If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned via the details list in the Operation.error field. The caller must have `resourcemanager.folders.create` permission on the identified parent. */
|
|
242
260
|
create(request: {
|
|
243
261
|
/** V1 error format. */
|
|
244
|
-
'$.xgafv'?:
|
|
262
|
+
'$.xgafv'?: '1' | '2';
|
|
245
263
|
/** OAuth access token. */
|
|
246
264
|
access_token?: string;
|
|
247
265
|
/** Data format for response. */
|
|
248
|
-
alt?:
|
|
266
|
+
alt?: 'json' | 'media' | 'proto';
|
|
249
267
|
/** JSONP */
|
|
250
268
|
callback?: string;
|
|
251
269
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -270,11 +288,11 @@ declare namespace gapi.client {
|
|
|
270
288
|
create(
|
|
271
289
|
request: {
|
|
272
290
|
/** V1 error format. */
|
|
273
|
-
'$.xgafv'?:
|
|
291
|
+
'$.xgafv'?: '1' | '2';
|
|
274
292
|
/** OAuth access token. */
|
|
275
293
|
access_token?: string;
|
|
276
294
|
/** Data format for response. */
|
|
277
|
-
alt?:
|
|
295
|
+
alt?: 'json' | 'media' | 'proto';
|
|
278
296
|
/** JSONP */
|
|
279
297
|
callback?: string;
|
|
280
298
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -299,11 +317,11 @@ declare namespace gapi.client {
|
|
|
299
317
|
/** Requests deletion of a Folder. The Folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty Folder in the ACTIVE state, where a Folder is empty if it doesn't contain any Folders or Projects in the ACTIVE state. The caller must have `resourcemanager.folders.delete` permission on the identified folder. */
|
|
300
318
|
delete(request?: {
|
|
301
319
|
/** V1 error format. */
|
|
302
|
-
'$.xgafv'?:
|
|
320
|
+
'$.xgafv'?: '1' | '2';
|
|
303
321
|
/** OAuth access token. */
|
|
304
322
|
access_token?: string;
|
|
305
323
|
/** Data format for response. */
|
|
306
|
-
alt?:
|
|
324
|
+
alt?: 'json' | 'media' | 'proto';
|
|
307
325
|
/** JSONP */
|
|
308
326
|
callback?: string;
|
|
309
327
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -326,11 +344,11 @@ declare namespace gapi.client {
|
|
|
326
344
|
/** Retrieves a Folder identified by the supplied resource name. Valid Folder resource names have the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have `resourcemanager.folders.get` permission on the identified folder. */
|
|
327
345
|
get(request?: {
|
|
328
346
|
/** V1 error format. */
|
|
329
|
-
'$.xgafv'?:
|
|
347
|
+
'$.xgafv'?: '1' | '2';
|
|
330
348
|
/** OAuth access token. */
|
|
331
349
|
access_token?: string;
|
|
332
350
|
/** Data format for response. */
|
|
333
|
-
alt?:
|
|
351
|
+
alt?: 'json' | 'media' | 'proto';
|
|
334
352
|
/** JSONP */
|
|
335
353
|
callback?: string;
|
|
336
354
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -354,11 +372,11 @@ declare namespace gapi.client {
|
|
|
354
372
|
getIamPolicy(
|
|
355
373
|
request: {
|
|
356
374
|
/** V1 error format. */
|
|
357
|
-
'$.xgafv'?:
|
|
375
|
+
'$.xgafv'?: '1' | '2';
|
|
358
376
|
/** OAuth access token. */
|
|
359
377
|
access_token?: string;
|
|
360
378
|
/** Data format for response. */
|
|
361
|
-
alt?:
|
|
379
|
+
alt?: 'json' | 'media' | 'proto';
|
|
362
380
|
/** JSONP */
|
|
363
381
|
callback?: string;
|
|
364
382
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -383,11 +401,11 @@ declare namespace gapi.client {
|
|
|
383
401
|
/** Lists the Folders that are direct descendants of supplied parent resource. List provides a strongly consistent view of the Folders underneath the specified parent resource. List returns Folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent. */
|
|
384
402
|
list(request?: {
|
|
385
403
|
/** V1 error format. */
|
|
386
|
-
'$.xgafv'?:
|
|
404
|
+
'$.xgafv'?: '1' | '2';
|
|
387
405
|
/** OAuth access token. */
|
|
388
406
|
access_token?: string;
|
|
389
407
|
/** Data format for response. */
|
|
390
|
-
alt?:
|
|
408
|
+
alt?: 'json' | 'media' | 'proto';
|
|
391
409
|
/** JSONP */
|
|
392
410
|
callback?: string;
|
|
393
411
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -416,11 +434,11 @@ declare namespace gapi.client {
|
|
|
416
434
|
/** Moves a Folder under a new resource parent. Returns an Operation which can be used to track the progress of the folder move workflow. Upon success the Operation.response field will be populated with the moved Folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the FolderOperationError will be returned via the Status.details field and if it occurs asynchronously then the FolderOperation will be returned via the Operation.error field. In addition, the Operation.metadata field will be populated with a FolderOperation message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent. */
|
|
417
435
|
move(request: {
|
|
418
436
|
/** V1 error format. */
|
|
419
|
-
'$.xgafv'?:
|
|
437
|
+
'$.xgafv'?: '1' | '2';
|
|
420
438
|
/** OAuth access token. */
|
|
421
439
|
access_token?: string;
|
|
422
440
|
/** Data format for response. */
|
|
423
|
-
alt?:
|
|
441
|
+
alt?: 'json' | 'media' | 'proto';
|
|
424
442
|
/** JSONP */
|
|
425
443
|
callback?: string;
|
|
426
444
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -445,11 +463,11 @@ declare namespace gapi.client {
|
|
|
445
463
|
move(
|
|
446
464
|
request: {
|
|
447
465
|
/** V1 error format. */
|
|
448
|
-
'$.xgafv'?:
|
|
466
|
+
'$.xgafv'?: '1' | '2';
|
|
449
467
|
/** OAuth access token. */
|
|
450
468
|
access_token?: string;
|
|
451
469
|
/** Data format for response. */
|
|
452
|
-
alt?:
|
|
470
|
+
alt?: 'json' | 'media' | 'proto';
|
|
453
471
|
/** JSONP */
|
|
454
472
|
callback?: string;
|
|
455
473
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -474,11 +492,11 @@ declare namespace gapi.client {
|
|
|
474
492
|
/** Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. The Folder's display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: `\p{L}\p{N}{1,28}[\p{L}\p{N}]`. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field. */
|
|
475
493
|
patch(request: {
|
|
476
494
|
/** V1 error format. */
|
|
477
|
-
'$.xgafv'?:
|
|
495
|
+
'$.xgafv'?: '1' | '2';
|
|
478
496
|
/** OAuth access token. */
|
|
479
497
|
access_token?: string;
|
|
480
498
|
/** Data format for response. */
|
|
481
|
-
alt?:
|
|
499
|
+
alt?: 'json' | 'media' | 'proto';
|
|
482
500
|
/** JSONP */
|
|
483
501
|
callback?: string;
|
|
484
502
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -505,11 +523,11 @@ declare namespace gapi.client {
|
|
|
505
523
|
patch(
|
|
506
524
|
request: {
|
|
507
525
|
/** V1 error format. */
|
|
508
|
-
'$.xgafv'?:
|
|
526
|
+
'$.xgafv'?: '1' | '2';
|
|
509
527
|
/** OAuth access token. */
|
|
510
528
|
access_token?: string;
|
|
511
529
|
/** Data format for response. */
|
|
512
|
-
alt?:
|
|
530
|
+
alt?: 'json' | 'media' | 'proto';
|
|
513
531
|
/** JSONP */
|
|
514
532
|
callback?: string;
|
|
515
533
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -536,11 +554,11 @@ declare namespace gapi.client {
|
|
|
536
554
|
/** Search for folders that match specific filter criteria. Search provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`. */
|
|
537
555
|
search(request: {
|
|
538
556
|
/** V1 error format. */
|
|
539
|
-
'$.xgafv'?:
|
|
557
|
+
'$.xgafv'?: '1' | '2';
|
|
540
558
|
/** OAuth access token. */
|
|
541
559
|
access_token?: string;
|
|
542
560
|
/** Data format for response. */
|
|
543
|
-
alt?:
|
|
561
|
+
alt?: 'json' | 'media' | 'proto';
|
|
544
562
|
/** JSONP */
|
|
545
563
|
callback?: string;
|
|
546
564
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -563,11 +581,11 @@ declare namespace gapi.client {
|
|
|
563
581
|
search(
|
|
564
582
|
request: {
|
|
565
583
|
/** V1 error format. */
|
|
566
|
-
'$.xgafv'?:
|
|
584
|
+
'$.xgafv'?: '1' | '2';
|
|
567
585
|
/** OAuth access token. */
|
|
568
586
|
access_token?: string;
|
|
569
587
|
/** Data format for response. */
|
|
570
|
-
alt?:
|
|
588
|
+
alt?: 'json' | 'media' | 'proto';
|
|
571
589
|
/** JSONP */
|
|
572
590
|
callback?: string;
|
|
573
591
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -591,11 +609,11 @@ declare namespace gapi.client {
|
|
|
591
609
|
setIamPolicy(
|
|
592
610
|
request: {
|
|
593
611
|
/** V1 error format. */
|
|
594
|
-
'$.xgafv'?:
|
|
612
|
+
'$.xgafv'?: '1' | '2';
|
|
595
613
|
/** OAuth access token. */
|
|
596
614
|
access_token?: string;
|
|
597
615
|
/** Data format for response. */
|
|
598
|
-
alt?:
|
|
616
|
+
alt?: 'json' | 'media' | 'proto';
|
|
599
617
|
/** JSONP */
|
|
600
618
|
callback?: string;
|
|
601
619
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -621,11 +639,11 @@ declare namespace gapi.client {
|
|
|
621
639
|
testIamPermissions(
|
|
622
640
|
request: {
|
|
623
641
|
/** V1 error format. */
|
|
624
|
-
'$.xgafv'?:
|
|
642
|
+
'$.xgafv'?: '1' | '2';
|
|
625
643
|
/** OAuth access token. */
|
|
626
644
|
access_token?: string;
|
|
627
645
|
/** Data format for response. */
|
|
628
|
-
alt?:
|
|
646
|
+
alt?: 'json' | 'media' | 'proto';
|
|
629
647
|
/** JSONP */
|
|
630
648
|
callback?: string;
|
|
631
649
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -650,11 +668,11 @@ declare namespace gapi.client {
|
|
|
650
668
|
/** Cancels the deletion request for a Folder. This method may only be called on a Folder in the DELETE_REQUESTED state. In order to succeed, the Folder's parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height and fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.undelete` permission on the identified folder. */
|
|
651
669
|
undelete(request: {
|
|
652
670
|
/** V1 error format. */
|
|
653
|
-
'$.xgafv'?:
|
|
671
|
+
'$.xgafv'?: '1' | '2';
|
|
654
672
|
/** OAuth access token. */
|
|
655
673
|
access_token?: string;
|
|
656
674
|
/** Data format for response. */
|
|
657
|
-
alt?:
|
|
675
|
+
alt?: 'json' | 'media' | 'proto';
|
|
658
676
|
/** JSONP */
|
|
659
677
|
callback?: string;
|
|
660
678
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -679,11 +697,11 @@ declare namespace gapi.client {
|
|
|
679
697
|
undelete(
|
|
680
698
|
request: {
|
|
681
699
|
/** V1 error format. */
|
|
682
|
-
'$.xgafv'?:
|
|
700
|
+
'$.xgafv'?: '1' | '2';
|
|
683
701
|
/** OAuth access token. */
|
|
684
702
|
access_token?: string;
|
|
685
703
|
/** Data format for response. */
|
|
686
|
-
alt?:
|
|
704
|
+
alt?: 'json' | 'media' | 'proto';
|
|
687
705
|
/** JSONP */
|
|
688
706
|
callback?: string;
|
|
689
707
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -710,11 +728,11 @@ declare namespace gapi.client {
|
|
|
710
728
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
711
729
|
get(request?: {
|
|
712
730
|
/** V1 error format. */
|
|
713
|
-
'$.xgafv'?:
|
|
731
|
+
'$.xgafv'?: '1' | '2';
|
|
714
732
|
/** OAuth access token. */
|
|
715
733
|
access_token?: string;
|
|
716
734
|
/** Data format for response. */
|
|
717
|
-
alt?:
|
|
735
|
+
alt?: 'json' | 'media' | 'proto';
|
|
718
736
|
/** JSONP */
|
|
719
737
|
callback?: string;
|
|
720
738
|
/** Selector specifying which fields to include in a partial response. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,23 @@ Install typings for Cloud Resource Manager API:
|
|
|
11
11
|
npm install @types/gapi.client.cloudresourcemanager-v2beta1 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": [
|
|
22
|
+
"gapi",
|
|
23
|
+
"gapi.auth2",
|
|
24
|
+
"gapi.client",
|
|
25
|
+
"gapi.client.cloudresourcemanager-v2beta1"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
14
31
|
## Usage
|
|
15
32
|
|
|
16
33
|
You need to initialize Google API client in your code:
|