@maxim_mazurok/gapi.client.osconfig-v1alpha 0.0.20231124 → 0.0.20231204

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.
Files changed (6) hide show
  1. package/index.d.ts +1266 -1961
  2. package/package.json +6 -6
  3. package/readme.md +17 -12
  4. package/tests.ts +0 -599
  5. package/tsconfig.json +0 -18
  6. package/tslint.json +0 -6
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.osconfig-v1alpha",
3
- "version": "0.0.20231124",
3
+ "version": "0.0.20231204",
4
4
  "description": "TypeScript typings for OS Config API v1alpha",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
8
+ },
5
9
  "license": "MIT",
6
10
  "author": {
7
- "email": "maxim@mazurok.com",
8
11
  "name": "Maxim Mazurok",
12
+ "email": "maxim@mazurok.com",
9
13
  "url": "https://maxim.mazurok.com"
10
14
  },
11
- "repository": {
12
- "type": "git",
13
- "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
14
- },
15
15
  "types": "index.d.ts",
16
16
  "dependencies": {
17
17
  "@types/gapi.client": "*",
package/readme.md CHANGED
@@ -25,10 +25,13 @@ gapi.load('client', () => {
25
25
  Then load api client wrapper:
26
26
 
27
27
  ```typescript
28
- gapi.client.load('https://osconfig.googleapis.com/$discovery/rest?version=v1alpha', () => {
29
- // now we can use:
30
- // gapi.client.osconfig
31
- });
28
+ gapi.client.load(
29
+ 'https://osconfig.googleapis.com/$discovery/rest?version=v1alpha',
30
+ () => {
31
+ // now we can use:
32
+ // gapi.client.osconfig
33
+ }
34
+ );
32
35
  ```
33
36
 
34
37
  ```typescript
@@ -45,24 +48,26 @@ Don't forget to authenticate your client before sending any request to resources
45
48
  // declare client_id registered in Google Developers Console
46
49
  var client_id = '',
47
50
  scope = [
48
- // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
49
- 'https://www.googleapis.com/auth/cloud-platform',
50
- ],
51
- immediate = true;
51
+ // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
52
+ 'https://www.googleapis.com/auth/cloud-platform',
53
+ ],
54
+ immediate = true;
52
55
  // ...
53
56
 
54
57
  gapi.auth.authorize(
55
- { client_id: client_id, scope: scope, immediate: immediate },
58
+ {client_id: client_id, scope: scope, immediate: immediate},
56
59
  authResult => {
57
60
  if (authResult && !authResult.error) {
58
- /* handle successful authorization */
61
+ /* handle successful authorization */
59
62
  } else {
60
- /* handle authorization error */
63
+ /* handle authorization error */
61
64
  }
62
- });
65
+ }
66
+ );
63
67
  ```
64
68
 
65
69
  After that you can use OS Config API resources: <!-- TODO: make this work for multiple namespaces -->
66
70
 
67
71
  ```typescript
72
+
68
73
  ```
package/tests.ts DELETED
@@ -1,599 +0,0 @@
1
- /* This is stub file for gapi.client.osconfig-v1alpha definition tests */
2
- // IMPORTANT
3
- // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
- // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
-
6
- // Revision: 20231124
7
-
8
- gapi.load('client', async () => {
9
- /** now we can use gapi.client */
10
-
11
- await gapi.client.load('https://osconfig.googleapis.com/$discovery/rest?version=v1alpha');
12
- /** now we can use gapi.client.osconfig */
13
-
14
- /** don't forget to authenticate your client before sending any request to resources: */
15
- /** declare client_id registered in Google Developers Console */
16
- const client_id = '<<PUT YOUR CLIENT ID HERE>>';
17
- const scope = [
18
- /** See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. */
19
- 'https://www.googleapis.com/auth/cloud-platform',
20
- ];
21
- const immediate = false;
22
- gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
23
- if (authResult && !authResult.error) {
24
- /** handle successful authorization */
25
- run();
26
- } else {
27
- /** handle authorization error */
28
- }
29
- });
30
-
31
- async function run() {
32
- /** Get OS policies compliance data for the specified Compute Engine VM instance. */
33
- await gapi.client.osconfig.projects.locations.instanceOSPoliciesCompliances.get({
34
- name: "Test string",
35
- });
36
- /** List OS policies compliance data for all Compute Engine VM instances in the specified zone. */
37
- await gapi.client.osconfig.projects.locations.instanceOSPoliciesCompliances.list({
38
- filter: "Test string",
39
- pageSize: 42,
40
- pageToken: "Test string",
41
- parent: "Test string",
42
- });
43
- /** Get inventory data for the specified VM instance. If the VM has no associated inventory, the message `NOT_FOUND` is returned. */
44
- await gapi.client.osconfig.projects.locations.instances.inventories.get({
45
- name: "Test string",
46
- view: "Test string",
47
- });
48
- /** List inventory data for all VM instances in the specified zone. */
49
- await gapi.client.osconfig.projects.locations.instances.inventories.list({
50
- filter: "Test string",
51
- pageSize: 42,
52
- pageToken: "Test string",
53
- parent: "Test string",
54
- view: "Test string",
55
- });
56
- /** Get the OS policy assignment report for the specified Compute Engine VM instance. */
57
- await gapi.client.osconfig.projects.locations.instances.osPolicyAssignments.reports.get({
58
- name: "Test string",
59
- });
60
- /** List OS policy assignment reports for all Compute Engine VM instances in the specified zone. */
61
- await gapi.client.osconfig.projects.locations.instances.osPolicyAssignments.reports.list({
62
- filter: "Test string",
63
- pageSize: 42,
64
- pageToken: "Test string",
65
- parent: "Test string",
66
- });
67
- /** Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them. */
68
- await gapi.client.osconfig.projects.locations.instances.vulnerabilityReports.get({
69
- name: "Test string",
70
- });
71
- /** List vulnerability reports for all VM instances in the specified zone. */
72
- await gapi.client.osconfig.projects.locations.instances.vulnerabilityReports.list({
73
- filter: "Test string",
74
- pageSize: 42,
75
- pageToken: "Test string",
76
- parent: "Test string",
77
- });
78
- /**
79
- * Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout
80
- * details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method:
81
- * projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
82
- */
83
- await gapi.client.osconfig.projects.locations.osPolicyAssignments.create({
84
- osPolicyAssignmentId: "Test string",
85
- parent: "Test string",
86
- }, {
87
- baseline: true,
88
- deleted: true,
89
- description: "Test string",
90
- etag: "Test string",
91
- instanceFilter: {
92
- all: true,
93
- exclusionLabels: [
94
- {
95
- labels: {
96
- A: "Test string"
97
- },
98
- }
99
- ],
100
- inclusionLabels: [
101
- {
102
- labels: {
103
- A: "Test string"
104
- },
105
- }
106
- ],
107
- inventories: [
108
- {
109
- osShortName: "Test string",
110
- osVersion: "Test string",
111
- }
112
- ],
113
- osShortNames: [
114
- "Test string"
115
- ],
116
- },
117
- name: "Test string",
118
- osPolicies: [
119
- {
120
- allowNoResourceGroupMatch: true,
121
- description: "Test string",
122
- id: "Test string",
123
- mode: "Test string",
124
- resourceGroups: [
125
- {
126
- inventoryFilters: [
127
- {
128
- osShortName: "Test string",
129
- osVersion: "Test string",
130
- }
131
- ],
132
- osFilter: {
133
- osShortName: "Test string",
134
- osVersion: "Test string",
135
- },
136
- resources: [
137
- {
138
- exec: {
139
- enforce: {
140
- args: [
141
- "Test string"
142
- ],
143
- file: {
144
- allowInsecure: true,
145
- gcs: {
146
- bucket: "Test string",
147
- generation: "Test string",
148
- object: "Test string",
149
- },
150
- localPath: "Test string",
151
- remote: {
152
- sha256Checksum: "Test string",
153
- uri: "Test string",
154
- },
155
- },
156
- interpreter: "Test string",
157
- outputFilePath: "Test string",
158
- script: "Test string",
159
- },
160
- validate: {
161
- args: [
162
- "Test string"
163
- ],
164
- file: {
165
- allowInsecure: true,
166
- gcs: {
167
- bucket: "Test string",
168
- generation: "Test string",
169
- object: "Test string",
170
- },
171
- localPath: "Test string",
172
- remote: {
173
- sha256Checksum: "Test string",
174
- uri: "Test string",
175
- },
176
- },
177
- interpreter: "Test string",
178
- outputFilePath: "Test string",
179
- script: "Test string",
180
- },
181
- },
182
- file: {
183
- content: "Test string",
184
- file: {
185
- allowInsecure: true,
186
- gcs: {
187
- bucket: "Test string",
188
- generation: "Test string",
189
- object: "Test string",
190
- },
191
- localPath: "Test string",
192
- remote: {
193
- sha256Checksum: "Test string",
194
- uri: "Test string",
195
- },
196
- },
197
- path: "Test string",
198
- permissions: "Test string",
199
- state: "Test string",
200
- },
201
- id: "Test string",
202
- pkg: {
203
- apt: {
204
- name: "Test string",
205
- },
206
- deb: {
207
- pullDeps: true,
208
- source: {
209
- allowInsecure: true,
210
- gcs: {
211
- bucket: "Test string",
212
- generation: "Test string",
213
- object: "Test string",
214
- },
215
- localPath: "Test string",
216
- remote: {
217
- sha256Checksum: "Test string",
218
- uri: "Test string",
219
- },
220
- },
221
- },
222
- desiredState: "Test string",
223
- googet: {
224
- name: "Test string",
225
- },
226
- msi: {
227
- properties: [
228
- "Test string"
229
- ],
230
- source: {
231
- allowInsecure: true,
232
- gcs: {
233
- bucket: "Test string",
234
- generation: "Test string",
235
- object: "Test string",
236
- },
237
- localPath: "Test string",
238
- remote: {
239
- sha256Checksum: "Test string",
240
- uri: "Test string",
241
- },
242
- },
243
- },
244
- rpm: {
245
- pullDeps: true,
246
- source: {
247
- allowInsecure: true,
248
- gcs: {
249
- bucket: "Test string",
250
- generation: "Test string",
251
- object: "Test string",
252
- },
253
- localPath: "Test string",
254
- remote: {
255
- sha256Checksum: "Test string",
256
- uri: "Test string",
257
- },
258
- },
259
- },
260
- yum: {
261
- name: "Test string",
262
- },
263
- zypper: {
264
- name: "Test string",
265
- },
266
- },
267
- repository: {
268
- apt: {
269
- archiveType: "Test string",
270
- components: [
271
- "Test string"
272
- ],
273
- distribution: "Test string",
274
- gpgKey: "Test string",
275
- uri: "Test string",
276
- },
277
- goo: {
278
- name: "Test string",
279
- url: "Test string",
280
- },
281
- yum: {
282
- baseUrl: "Test string",
283
- displayName: "Test string",
284
- gpgKeys: [
285
- "Test string"
286
- ],
287
- id: "Test string",
288
- },
289
- zypper: {
290
- baseUrl: "Test string",
291
- displayName: "Test string",
292
- gpgKeys: [
293
- "Test string"
294
- ],
295
- id: "Test string",
296
- },
297
- },
298
- }
299
- ],
300
- }
301
- ],
302
- }
303
- ],
304
- reconciling: true,
305
- revisionCreateTime: "Test string",
306
- revisionId: "Test string",
307
- rollout: {
308
- disruptionBudget: {
309
- fixed: 42,
310
- percent: 42,
311
- },
312
- minWaitDuration: "Test string",
313
- },
314
- rolloutState: "Test string",
315
- uid: "Test string",
316
- });
317
- /**
318
- * Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details.
319
- * The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information,
320
- * see [Method:
321
- * projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
322
- */
323
- await gapi.client.osconfig.projects.locations.osPolicyAssignments.delete({
324
- name: "Test string",
325
- });
326
- /**
327
- * Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in
328
- * the `name` parameter.
329
- */
330
- await gapi.client.osconfig.projects.locations.osPolicyAssignments.get({
331
- name: "Test string",
332
- });
333
- /** List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned. */
334
- await gapi.client.osconfig.projects.locations.osPolicyAssignments.list({
335
- pageSize: 42,
336
- pageToken: "Test string",
337
- parent: "Test string",
338
- });
339
- /** List the OS policy assignment revisions for a given OS policy assignment. */
340
- await gapi.client.osconfig.projects.locations.osPolicyAssignments.listRevisions({
341
- name: "Test string",
342
- pageSize: 42,
343
- pageToken: "Test string",
344
- });
345
- /**
346
- * Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout
347
- * details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method:
348
- * projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
349
- */
350
- await gapi.client.osconfig.projects.locations.osPolicyAssignments.patch({
351
- name: "Test string",
352
- updateMask: "Test string",
353
- }, {
354
- baseline: true,
355
- deleted: true,
356
- description: "Test string",
357
- etag: "Test string",
358
- instanceFilter: {
359
- all: true,
360
- exclusionLabels: [
361
- {
362
- labels: {
363
- A: "Test string"
364
- },
365
- }
366
- ],
367
- inclusionLabels: [
368
- {
369
- labels: {
370
- A: "Test string"
371
- },
372
- }
373
- ],
374
- inventories: [
375
- {
376
- osShortName: "Test string",
377
- osVersion: "Test string",
378
- }
379
- ],
380
- osShortNames: [
381
- "Test string"
382
- ],
383
- },
384
- name: "Test string",
385
- osPolicies: [
386
- {
387
- allowNoResourceGroupMatch: true,
388
- description: "Test string",
389
- id: "Test string",
390
- mode: "Test string",
391
- resourceGroups: [
392
- {
393
- inventoryFilters: [
394
- {
395
- osShortName: "Test string",
396
- osVersion: "Test string",
397
- }
398
- ],
399
- osFilter: {
400
- osShortName: "Test string",
401
- osVersion: "Test string",
402
- },
403
- resources: [
404
- {
405
- exec: {
406
- enforce: {
407
- args: [
408
- "Test string"
409
- ],
410
- file: {
411
- allowInsecure: true,
412
- gcs: {
413
- bucket: "Test string",
414
- generation: "Test string",
415
- object: "Test string",
416
- },
417
- localPath: "Test string",
418
- remote: {
419
- sha256Checksum: "Test string",
420
- uri: "Test string",
421
- },
422
- },
423
- interpreter: "Test string",
424
- outputFilePath: "Test string",
425
- script: "Test string",
426
- },
427
- validate: {
428
- args: [
429
- "Test string"
430
- ],
431
- file: {
432
- allowInsecure: true,
433
- gcs: {
434
- bucket: "Test string",
435
- generation: "Test string",
436
- object: "Test string",
437
- },
438
- localPath: "Test string",
439
- remote: {
440
- sha256Checksum: "Test string",
441
- uri: "Test string",
442
- },
443
- },
444
- interpreter: "Test string",
445
- outputFilePath: "Test string",
446
- script: "Test string",
447
- },
448
- },
449
- file: {
450
- content: "Test string",
451
- file: {
452
- allowInsecure: true,
453
- gcs: {
454
- bucket: "Test string",
455
- generation: "Test string",
456
- object: "Test string",
457
- },
458
- localPath: "Test string",
459
- remote: {
460
- sha256Checksum: "Test string",
461
- uri: "Test string",
462
- },
463
- },
464
- path: "Test string",
465
- permissions: "Test string",
466
- state: "Test string",
467
- },
468
- id: "Test string",
469
- pkg: {
470
- apt: {
471
- name: "Test string",
472
- },
473
- deb: {
474
- pullDeps: true,
475
- source: {
476
- allowInsecure: true,
477
- gcs: {
478
- bucket: "Test string",
479
- generation: "Test string",
480
- object: "Test string",
481
- },
482
- localPath: "Test string",
483
- remote: {
484
- sha256Checksum: "Test string",
485
- uri: "Test string",
486
- },
487
- },
488
- },
489
- desiredState: "Test string",
490
- googet: {
491
- name: "Test string",
492
- },
493
- msi: {
494
- properties: [
495
- "Test string"
496
- ],
497
- source: {
498
- allowInsecure: true,
499
- gcs: {
500
- bucket: "Test string",
501
- generation: "Test string",
502
- object: "Test string",
503
- },
504
- localPath: "Test string",
505
- remote: {
506
- sha256Checksum: "Test string",
507
- uri: "Test string",
508
- },
509
- },
510
- },
511
- rpm: {
512
- pullDeps: true,
513
- source: {
514
- allowInsecure: true,
515
- gcs: {
516
- bucket: "Test string",
517
- generation: "Test string",
518
- object: "Test string",
519
- },
520
- localPath: "Test string",
521
- remote: {
522
- sha256Checksum: "Test string",
523
- uri: "Test string",
524
- },
525
- },
526
- },
527
- yum: {
528
- name: "Test string",
529
- },
530
- zypper: {
531
- name: "Test string",
532
- },
533
- },
534
- repository: {
535
- apt: {
536
- archiveType: "Test string",
537
- components: [
538
- "Test string"
539
- ],
540
- distribution: "Test string",
541
- gpgKey: "Test string",
542
- uri: "Test string",
543
- },
544
- goo: {
545
- name: "Test string",
546
- url: "Test string",
547
- },
548
- yum: {
549
- baseUrl: "Test string",
550
- displayName: "Test string",
551
- gpgKeys: [
552
- "Test string"
553
- ],
554
- id: "Test string",
555
- },
556
- zypper: {
557
- baseUrl: "Test string",
558
- displayName: "Test string",
559
- gpgKeys: [
560
- "Test string"
561
- ],
562
- id: "Test string",
563
- },
564
- },
565
- }
566
- ],
567
- }
568
- ],
569
- }
570
- ],
571
- reconciling: true,
572
- revisionCreateTime: "Test string",
573
- revisionId: "Test string",
574
- rollout: {
575
- disruptionBudget: {
576
- fixed: 42,
577
- percent: 42,
578
- },
579
- minWaitDuration: "Test string",
580
- },
581
- rolloutState: "Test string",
582
- uid: "Test string",
583
- });
584
- /**
585
- * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this
586
- * method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation
587
- * completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of
588
- * 1, corresponding to `Code.CANCELLED`.
589
- */
590
- await gapi.client.osconfig.projects.locations.osPolicyAssignments.operations.cancel({
591
- name: "Test string",
592
- }, {
593
- });
594
- /** 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. */
595
- await gapi.client.osconfig.projects.locations.osPolicyAssignments.operations.get({
596
- name: "Test string",
597
- });
598
- }
599
- });