@googleapis/chromemanagement 3.0.0 → 4.0.0

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 CHANGED
@@ -1,5 +1,24 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/chromemanagement-v3.1.0...chromemanagement-v4.0.0) (2023-02-10)
4
+
5
+
6
+ ### ⚠ BREAKING CHANGES
7
+
8
+ * **chromemanagement:** This release has breaking changes.
9
+
10
+ ### Features
11
+
12
+ * **chromemanagement:** update the API ([3368e8d](https://github.com/googleapis/google-api-nodejs-client/commit/3368e8dd0e6b92d05fdaf43069758d2c0c01a3f6))
13
+ * **chromemanagement:** update the API ([76eea6c](https://github.com/googleapis/google-api-nodejs-client/commit/76eea6cdcb93e4c67e70573e729332dc6bff619d))
14
+
15
+ ## [3.1.0](https://github.com/googleapis/google-api-nodejs-client/compare/chromemanagement-v3.0.0...chromemanagement-v3.1.0) (2022-12-22)
16
+
17
+
18
+ ### Features
19
+
20
+ * **chromemanagement:** update the API ([bf3db6d](https://github.com/googleapis/google-api-nodejs-client/commit/bf3db6d9b105e954b4e180766747877d215e7ee8))
21
+
3
22
  ## [3.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/chromemanagement-v2.3.0...chromemanagement-v3.0.0) (2022-10-28)
4
23
 
5
24
 
package/build/v1.d.ts CHANGED
@@ -396,6 +396,10 @@ export declare namespace chromemanagement_v1 {
396
396
  * Output only. The app developer has enabled support for their app. Version-specific field that will only be set when the requested app version is found.
397
397
  */
398
398
  supportEnabled?: boolean | null;
399
+ /**
400
+ * Output only. Types of an item in the Chrome Web Store
401
+ */
402
+ type?: string | null;
399
403
  }
400
404
  /**
401
405
  * Permission requested by a Chrome app or extension.
@@ -798,7 +802,7 @@ export declare namespace chromemanagement_v1 {
798
802
  adapterInfo?: Schema$GoogleChromeManagementV1GraphicsAdapterInfo;
799
803
  }
800
804
  /**
801
- * Information of the graphics subsystem. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceGraphicsInfo](https://chromeenterprise.google/policies/#ReportDeviceGraphicsInfo) * Data Collection Frequency: Only at Upload * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A
805
+ * Information of the graphics subsystem. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceGraphicsInfo](https://chromeenterprise.google/policies/#ReportDeviceGraphicsInfo) * Data Collection Frequency: 3 hours. * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A
802
806
  */
803
807
  export interface Schema$GoogleChromeManagementV1GraphicsStatusReport {
804
808
  /**
@@ -882,6 +886,32 @@ export declare namespace chromemanagement_v1 {
882
886
  */
883
887
  nextPageToken?: string | null;
884
888
  }
889
+ /**
890
+ * Response message for listing telemetry events for a customer.
891
+ */
892
+ export interface Schema$GoogleChromeManagementV1ListTelemetryEventsResponse {
893
+ /**
894
+ * Token to specify next page in the list.
895
+ */
896
+ nextPageToken?: string | null;
897
+ /**
898
+ * Telemetry events returned in the response.
899
+ */
900
+ telemetryEvents?: Schema$GoogleChromeManagementV1TelemetryEvent[];
901
+ }
902
+ /**
903
+ * Response message for listing telemetry users for a customer.
904
+ */
905
+ export interface Schema$GoogleChromeManagementV1ListTelemetryUsersResponse {
906
+ /**
907
+ * Token to specify next page in the list.
908
+ */
909
+ nextPageToken?: string | null;
910
+ /**
911
+ * Telemetry users returned in the response.
912
+ */
913
+ telemetryUsers?: Schema$GoogleChromeManagementV1TelemetryUser[];
914
+ }
885
915
  /**
886
916
  * Memory information of a device. * This field has both telemetry and device information: - `totalRamBytes` - Device information - `availableRamBytes` - Telemetry information - `totalMemoryEncryption` - Device information * Data for this field is controlled via policy: [ReportDeviceMemoryInfo](https://chromeenterprise.google/policies/#ReportDeviceMemoryInfo) * Data Collection Frequency: - `totalRamBytes` - Only at upload - `availableRamBytes` - Every 10 minutes - `totalMemoryEncryption` - at device startup * Default Data Reporting Frequency: - `totalRamBytes` - 3 hours - `availableRamBytes` - 3 hours - `totalMemoryEncryption` - at device startup - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: only for `totalMemoryEncryption` * Reported for affiliated users only: N/A
887
917
  */
@@ -1061,6 +1091,19 @@ export declare namespace chromemanagement_v1 {
1061
1091
  */
1062
1092
  updateState?: string | null;
1063
1093
  }
1094
+ /**
1095
+ * Peripherals report.
1096
+ */
1097
+ export interface Schema$GoogleChromeManagementV1PeripheralsReport {
1098
+ /**
1099
+ * Output only. Timestamp of when the report was collected.
1100
+ */
1101
+ reportTime?: string | null;
1102
+ /**
1103
+ * Reports of all usb connected devices.
1104
+ */
1105
+ usbPeripheralReport?: Schema$GoogleChromeManagementV1UsbPeripheralReport[];
1106
+ }
1064
1107
  /**
1065
1108
  * Status data for storage. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceStorageStatus](https://chromeenterprise.google/policies/#ReportDeviceStorageStatus) * Data Collection Frequency: Only at Upload * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A
1066
1109
  */
@@ -1108,6 +1151,11 @@ export declare namespace chromemanagement_v1 {
1108
1151
  */
1109
1152
  reportTime?: string | null;
1110
1153
  }
1154
+ /**
1155
+ * `TelemetryAudioSevereUnderrunEvent` is triggered when a audio devices run out of buffer data for more than 5 seconds.
1156
+ */
1157
+ export interface Schema$GoogleChromeManagementV1TelemetryAudioSevereUnderrunEvent {
1158
+ }
1111
1159
  /**
1112
1160
  * Telemetry data collected from a managed device.
1113
1161
  */
@@ -1184,6 +1232,10 @@ export declare namespace chromemanagement_v1 {
1184
1232
  * Output only. Contains relevant information regarding ChromeOS update status.
1185
1233
  */
1186
1234
  osUpdateStatus?: Schema$GoogleChromeManagementV1OsUpdateStatus[];
1235
+ /**
1236
+ * Output only. Peripherals reports collected periodically sorted in a decreasing order of report_time.
1237
+ */
1238
+ peripheralsReport?: Schema$GoogleChromeManagementV1PeripheralsReport[];
1187
1239
  /**
1188
1240
  * Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab.
1189
1241
  */
@@ -1201,6 +1253,137 @@ export declare namespace chromemanagement_v1 {
1201
1253
  */
1202
1254
  thunderboltInfo?: Schema$GoogleChromeManagementV1ThunderboltInfo[];
1203
1255
  }
1256
+ /**
1257
+ * Information about a device associated with telemetry data.
1258
+ */
1259
+ export interface Schema$GoogleChromeManagementV1TelemetryDeviceInfo {
1260
+ /**
1261
+ * Output only. The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab.
1262
+ */
1263
+ deviceId?: string | null;
1264
+ /**
1265
+ * Output only. Organization unit ID of the device.
1266
+ */
1267
+ orgUnitId?: string | null;
1268
+ }
1269
+ /**
1270
+ * Telemetry data reported by a managed device.
1271
+ */
1272
+ export interface Schema$GoogleChromeManagementV1TelemetryEvent {
1273
+ /**
1274
+ * Output only. Payload for audio severe underrun event. Present only when the `event_type` field is `AUDIO_SEVERE_UNDERRUN`.
1275
+ */
1276
+ audioSevereUnderrunEvent?: Schema$GoogleChromeManagementV1TelemetryAudioSevereUnderrunEvent;
1277
+ /**
1278
+ * Output only. Information about the device associated with the event.
1279
+ */
1280
+ device?: Schema$GoogleChromeManagementV1TelemetryDeviceInfo;
1281
+ /**
1282
+ * The event type of the current event.
1283
+ */
1284
+ eventType?: string | null;
1285
+ /**
1286
+ * Output only. Payload for HTTPS latency change event. Present only when `event_type` is `NETWORK_HTTPS_LATENCY_CHANGE`.
1287
+ */
1288
+ httpsLatencyChangeEvent?: Schema$GoogleChromeManagementV1TelemetryHttpsLatencyChangeEvent;
1289
+ /**
1290
+ * Output only. Resource name of the event.
1291
+ */
1292
+ name?: string | null;
1293
+ /**
1294
+ * Timestamp that represents when the event was reported.
1295
+ */
1296
+ reportTime?: string | null;
1297
+ /**
1298
+ * Output only. Payload for usb peripherals event. Present only when the `event_type` field is either `USB_ADDED` or `USB_REMOVED`.
1299
+ */
1300
+ usbPeripheralsEvent?: Schema$GoogleChromeManagementV1TelemetryUsbPeripheralsEvent;
1301
+ /**
1302
+ * Output only. Information about the user associated with the event.
1303
+ */
1304
+ user?: Schema$GoogleChromeManagementV1TelemetryUserInfo;
1305
+ }
1306
+ /**
1307
+ * Https latency routine is run periodically and `TelemetryHttpsLatencyChangeEvent` is triggered if a latency problem was detected or if the device has recovered from a latency problem..
1308
+ */
1309
+ export interface Schema$GoogleChromeManagementV1TelemetryHttpsLatencyChangeEvent {
1310
+ /**
1311
+ * HTTPS latency routine data that triggered the event.
1312
+ */
1313
+ httpsLatencyRoutineData?: Schema$GoogleChromeManagementV1HttpsLatencyRoutineData;
1314
+ /**
1315
+ * Current HTTPS latency state.
1316
+ */
1317
+ httpsLatencyState?: string | null;
1318
+ }
1319
+ /**
1320
+ * `TelemetryUsbPeripheralsEvent` is triggered USB devices are either added or removed.
1321
+ */
1322
+ export interface Schema$GoogleChromeManagementV1TelemetryUsbPeripheralsEvent {
1323
+ /**
1324
+ * List of usb devices that were either added or removed.
1325
+ */
1326
+ usbPeripheralReport?: Schema$GoogleChromeManagementV1UsbPeripheralReport[];
1327
+ }
1328
+ /**
1329
+ * Telemetry data collected from a managed user.
1330
+ */
1331
+ export interface Schema$GoogleChromeManagementV1TelemetryUser {
1332
+ /**
1333
+ * G Suite Customer whose enterprise enrolled the device.
1334
+ */
1335
+ customer?: string | null;
1336
+ /**
1337
+ * Resource name of the user.
1338
+ */
1339
+ name?: string | null;
1340
+ /**
1341
+ * Organization unit of the user.
1342
+ */
1343
+ orgUnitId?: string | null;
1344
+ /**
1345
+ * Telemetry data collected from a managed user and device.
1346
+ */
1347
+ userDevice?: Schema$GoogleChromeManagementV1TelemetryUserDevice[];
1348
+ /**
1349
+ * Email address of the user.
1350
+ */
1351
+ userEmail?: string | null;
1352
+ /**
1353
+ * Directory ID of the user.
1354
+ */
1355
+ userId?: string | null;
1356
+ }
1357
+ /**
1358
+ * Telemetry data collected for a managed user and device.
1359
+ */
1360
+ export interface Schema$GoogleChromeManagementV1TelemetryUserDevice {
1361
+ /**
1362
+ * Output only. Audio reports collected periodically sorted in a decreasing order of report_time.
1363
+ */
1364
+ audioStatusReport?: Schema$GoogleChromeManagementV1AudioStatusReport[];
1365
+ /**
1366
+ * The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab.
1367
+ */
1368
+ deviceId?: string | null;
1369
+ /**
1370
+ * Output only. Peripherals reports collected periodically sorted in a decreasing order of report_time.
1371
+ */
1372
+ peripheralsReport?: Schema$GoogleChromeManagementV1PeripheralsReport[];
1373
+ }
1374
+ /**
1375
+ * Information about a user associated with telemetry data.
1376
+ */
1377
+ export interface Schema$GoogleChromeManagementV1TelemetryUserInfo {
1378
+ /**
1379
+ * Output only. User's email.
1380
+ */
1381
+ email?: string | null;
1382
+ /**
1383
+ * Output only. Organization unit ID of the user.
1384
+ */
1385
+ orgUnitId?: string | null;
1386
+ }
1204
1387
  /**
1205
1388
  * Thunderbolt bus info. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceSecurityStatus](https://chromeenterprise.google/policies/#ReportDeviceSecurityStatus) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: At device startup - Policy Controlled: No * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: Yes * Reported for affiliated users only: N/A
1206
1389
  */
@@ -1231,6 +1414,43 @@ export declare namespace chromemanagement_v1 {
1231
1414
  */
1232
1415
  maxKeys?: string | null;
1233
1416
  }
1417
+ /**
1418
+ * USB connected peripheral report.
1419
+ */
1420
+ export interface Schema$GoogleChromeManagementV1UsbPeripheralReport {
1421
+ /**
1422
+ * Output only. Categories the device belongs to https://www.usb.org/defined-class-codes
1423
+ */
1424
+ categories?: string[] | null;
1425
+ /**
1426
+ * Output only. Class ID https://www.usb.org/defined-class-codes
1427
+ */
1428
+ classId?: number | null;
1429
+ /**
1430
+ * Output only. Firmware version
1431
+ */
1432
+ firmwareVersion?: string | null;
1433
+ /**
1434
+ * Output only. Device name, model name, or product name
1435
+ */
1436
+ name?: string | null;
1437
+ /**
1438
+ * Output only. Product ID
1439
+ */
1440
+ pid?: number | null;
1441
+ /**
1442
+ * Output only. Subclass ID https://www.usb.org/defined-class-codes
1443
+ */
1444
+ subclassId?: number | null;
1445
+ /**
1446
+ * Output only. Vendor name
1447
+ */
1448
+ vendor?: string | null;
1449
+ /**
1450
+ * Output only. Vendor ID
1451
+ */
1452
+ vid?: number | null;
1453
+ }
1234
1454
  /**
1235
1455
  * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
1236
1456
  */
@@ -1933,9 +2153,9 @@ export declare namespace chromemanagement_v1 {
1933
2153
  * const res = await chromemanagement.customers.reports.countInstalledApps({
1934
2154
  * // Required. Customer id or "my_customer" to use the customer associated to the account making the request.
1935
2155
  * customer: 'customers/my-customer',
1936
- * // Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name
2156
+ * // Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id
1937
2157
  * filter: 'placeholder-value',
1938
- * // Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count
2158
+ * // Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id
1939
2159
  * orderBy: 'placeholder-value',
1940
2160
  * // The ID of the organizational unit.
1941
2161
  * orgUnitId: 'placeholder-value',
@@ -2121,11 +2341,11 @@ export declare namespace chromemanagement_v1 {
2121
2341
  */
2122
2342
  customer?: string;
2123
2343
  /**
2124
- * Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name
2344
+ * Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id
2125
2345
  */
2126
2346
  filter?: string;
2127
2347
  /**
2128
- * Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count
2348
+ * Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id
2129
2349
  */
2130
2350
  orderBy?: string;
2131
2351
  /**
@@ -2178,6 +2398,8 @@ export declare namespace chromemanagement_v1 {
2178
2398
  export class Resource$Customers$Telemetry {
2179
2399
  context: APIRequestContext;
2180
2400
  devices: Resource$Customers$Telemetry$Devices;
2401
+ events: Resource$Customers$Telemetry$Events;
2402
+ users: Resource$Customers$Telemetry$Users;
2181
2403
  constructor(context: APIRequestContext);
2182
2404
  }
2183
2405
  export class Resource$Customers$Telemetry$Devices {
@@ -2239,6 +2461,7 @@ export declare namespace chromemanagement_v1 {
2239
2461
  * // "networkStatusReport": [],
2240
2462
  * // "orgUnitId": "my_orgUnitId",
2241
2463
  * // "osUpdateStatus": [],
2464
+ * // "peripheralsReport": [],
2242
2465
  * // "serialNumber": "my_serialNumber",
2243
2466
  * // "storageInfo": {},
2244
2467
  * // "storageStatusReport": [],
@@ -2364,5 +2587,266 @@ export declare namespace chromemanagement_v1 {
2364
2587
  */
2365
2588
  readMask?: string;
2366
2589
  }
2590
+ export class Resource$Customers$Telemetry$Events {
2591
+ context: APIRequestContext;
2592
+ constructor(context: APIRequestContext);
2593
+ /**
2594
+ * List telemetry events.
2595
+ * @example
2596
+ * ```js
2597
+ * // Before running the sample:
2598
+ * // - Enable the API at:
2599
+ * // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
2600
+ * // - Login into gcloud by running:
2601
+ * // `$ gcloud auth application-default login`
2602
+ * // - Install the npm module by running:
2603
+ * // `$ npm install googleapis`
2604
+ *
2605
+ * const {google} = require('googleapis');
2606
+ * const chromemanagement = google.chromemanagement('v1');
2607
+ *
2608
+ * async function main() {
2609
+ * const auth = new google.auth.GoogleAuth({
2610
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2611
+ * scopes: [
2612
+ * 'https://www.googleapis.com/auth/chrome.management.telemetry.readonly',
2613
+ * ],
2614
+ * });
2615
+ *
2616
+ * // Acquire an auth client, and bind it to all future calls
2617
+ * const authClient = await auth.getClient();
2618
+ * google.options({auth: authClient});
2619
+ *
2620
+ * // Do the magic
2621
+ * const res = await chromemanagement.customers.telemetry.events.list({
2622
+ * // Optional. Only include resources that match the filter. Supported filter fields: - device_id - user_id - device_org_unit_id - user_org_unit_id - timestamp - event_type The "timestamp" filter accepts either Epoch milliseconds or RFC 3339 formatted time surrounded by simple double quotes.
2623
+ * filter: 'placeholder-value',
2624
+ * // Optional. Maximum number of results to return. Default value is 100. Maximum value is 1000.
2625
+ * pageSize: 'placeholder-value',
2626
+ * // Optional. Token to specify next page in the list.
2627
+ * pageToken: 'placeholder-value',
2628
+ * // Required. Customer id or "my_customer" to use the customer associated to the account making the request.
2629
+ * parent: 'customers/my-customer',
2630
+ * // Required. Read mask to specify which fields to return.
2631
+ * readMask: 'placeholder-value',
2632
+ * });
2633
+ * console.log(res.data);
2634
+ *
2635
+ * // Example response
2636
+ * // {
2637
+ * // "nextPageToken": "my_nextPageToken",
2638
+ * // "telemetryEvents": []
2639
+ * // }
2640
+ * }
2641
+ *
2642
+ * main().catch(e => {
2643
+ * console.error(e);
2644
+ * throw e;
2645
+ * });
2646
+ *
2647
+ * ```
2648
+ *
2649
+ * @param params - Parameters for request
2650
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2651
+ * @param callback - Optional callback that handles the response.
2652
+ * @returns A promise if used with async/await, or void if used with a callback.
2653
+ */
2654
+ list(params: Params$Resource$Customers$Telemetry$Events$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
2655
+ list(params?: Params$Resource$Customers$Telemetry$Events$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>;
2656
+ list(params: Params$Resource$Customers$Telemetry$Events$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2657
+ list(params: Params$Resource$Customers$Telemetry$Events$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>): void;
2658
+ list(params: Params$Resource$Customers$Telemetry$Events$List, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>): void;
2659
+ list(callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>): void;
2660
+ }
2661
+ export interface Params$Resource$Customers$Telemetry$Events$List extends StandardParameters {
2662
+ /**
2663
+ * Optional. Only include resources that match the filter. Supported filter fields: - device_id - user_id - device_org_unit_id - user_org_unit_id - timestamp - event_type The "timestamp" filter accepts either Epoch milliseconds or RFC 3339 formatted time surrounded by simple double quotes.
2664
+ */
2665
+ filter?: string;
2666
+ /**
2667
+ * Optional. Maximum number of results to return. Default value is 100. Maximum value is 1000.
2668
+ */
2669
+ pageSize?: number;
2670
+ /**
2671
+ * Optional. Token to specify next page in the list.
2672
+ */
2673
+ pageToken?: string;
2674
+ /**
2675
+ * Required. Customer id or "my_customer" to use the customer associated to the account making the request.
2676
+ */
2677
+ parent?: string;
2678
+ /**
2679
+ * Required. Read mask to specify which fields to return.
2680
+ */
2681
+ readMask?: string;
2682
+ }
2683
+ export class Resource$Customers$Telemetry$Users {
2684
+ context: APIRequestContext;
2685
+ constructor(context: APIRequestContext);
2686
+ /**
2687
+ * Get telemetry user.
2688
+ * @example
2689
+ * ```js
2690
+ * // Before running the sample:
2691
+ * // - Enable the API at:
2692
+ * // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
2693
+ * // - Login into gcloud by running:
2694
+ * // `$ gcloud auth application-default login`
2695
+ * // - Install the npm module by running:
2696
+ * // `$ npm install googleapis`
2697
+ *
2698
+ * const {google} = require('googleapis');
2699
+ * const chromemanagement = google.chromemanagement('v1');
2700
+ *
2701
+ * async function main() {
2702
+ * const auth = new google.auth.GoogleAuth({
2703
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2704
+ * scopes: [
2705
+ * 'https://www.googleapis.com/auth/chrome.management.telemetry.readonly',
2706
+ * ],
2707
+ * });
2708
+ *
2709
+ * // Acquire an auth client, and bind it to all future calls
2710
+ * const authClient = await auth.getClient();
2711
+ * google.options({auth: authClient});
2712
+ *
2713
+ * // Do the magic
2714
+ * const res = await chromemanagement.customers.telemetry.users.get({
2715
+ * // Required. Name of the `TelemetryUser` to return.
2716
+ * name: 'customers/my-customer/telemetry/users/my-user',
2717
+ * // Read mask to specify which fields to return.
2718
+ * readMask: 'placeholder-value',
2719
+ * });
2720
+ * console.log(res.data);
2721
+ *
2722
+ * // Example response
2723
+ * // {
2724
+ * // "customer": "my_customer",
2725
+ * // "name": "my_name",
2726
+ * // "orgUnitId": "my_orgUnitId",
2727
+ * // "userDevice": [],
2728
+ * // "userEmail": "my_userEmail",
2729
+ * // "userId": "my_userId"
2730
+ * // }
2731
+ * }
2732
+ *
2733
+ * main().catch(e => {
2734
+ * console.error(e);
2735
+ * throw e;
2736
+ * });
2737
+ *
2738
+ * ```
2739
+ *
2740
+ * @param params - Parameters for request
2741
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2742
+ * @param callback - Optional callback that handles the response.
2743
+ * @returns A promise if used with async/await, or void if used with a callback.
2744
+ */
2745
+ get(params: Params$Resource$Customers$Telemetry$Users$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
2746
+ get(params?: Params$Resource$Customers$Telemetry$Users$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleChromeManagementV1TelemetryUser>;
2747
+ get(params: Params$Resource$Customers$Telemetry$Users$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2748
+ get(params: Params$Resource$Customers$Telemetry$Users$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleChromeManagementV1TelemetryUser>, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1TelemetryUser>): void;
2749
+ get(params: Params$Resource$Customers$Telemetry$Users$Get, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1TelemetryUser>): void;
2750
+ get(callback: BodyResponseCallback<Schema$GoogleChromeManagementV1TelemetryUser>): void;
2751
+ /**
2752
+ * List all telemetry users.
2753
+ * @example
2754
+ * ```js
2755
+ * // Before running the sample:
2756
+ * // - Enable the API at:
2757
+ * // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
2758
+ * // - Login into gcloud by running:
2759
+ * // `$ gcloud auth application-default login`
2760
+ * // - Install the npm module by running:
2761
+ * // `$ npm install googleapis`
2762
+ *
2763
+ * const {google} = require('googleapis');
2764
+ * const chromemanagement = google.chromemanagement('v1');
2765
+ *
2766
+ * async function main() {
2767
+ * const auth = new google.auth.GoogleAuth({
2768
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2769
+ * scopes: [
2770
+ * 'https://www.googleapis.com/auth/chrome.management.telemetry.readonly',
2771
+ * ],
2772
+ * });
2773
+ *
2774
+ * // Acquire an auth client, and bind it to all future calls
2775
+ * const authClient = await auth.getClient();
2776
+ * google.options({auth: authClient});
2777
+ *
2778
+ * // Do the magic
2779
+ * const res = await chromemanagement.customers.telemetry.users.list({
2780
+ * // Only include resources that match the filter. Supported filter fields: - user_id - user_org_unit_id
2781
+ * filter: 'placeholder-value',
2782
+ * // Maximum number of results to return. Default value is 100. Maximum value is 1000.
2783
+ * pageSize: 'placeholder-value',
2784
+ * // Token to specify next page in the list.
2785
+ * pageToken: 'placeholder-value',
2786
+ * // Required. Customer id or "my_customer" to use the customer associated to the account making the request.
2787
+ * parent: 'customers/my-customer',
2788
+ * // Read mask to specify which fields to return.
2789
+ * readMask: 'placeholder-value',
2790
+ * });
2791
+ * console.log(res.data);
2792
+ *
2793
+ * // Example response
2794
+ * // {
2795
+ * // "nextPageToken": "my_nextPageToken",
2796
+ * // "telemetryUsers": []
2797
+ * // }
2798
+ * }
2799
+ *
2800
+ * main().catch(e => {
2801
+ * console.error(e);
2802
+ * throw e;
2803
+ * });
2804
+ *
2805
+ * ```
2806
+ *
2807
+ * @param params - Parameters for request
2808
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2809
+ * @param callback - Optional callback that handles the response.
2810
+ * @returns A promise if used with async/await, or void if used with a callback.
2811
+ */
2812
+ list(params: Params$Resource$Customers$Telemetry$Users$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
2813
+ list(params?: Params$Resource$Customers$Telemetry$Users$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>;
2814
+ list(params: Params$Resource$Customers$Telemetry$Users$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2815
+ list(params: Params$Resource$Customers$Telemetry$Users$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>): void;
2816
+ list(params: Params$Resource$Customers$Telemetry$Users$List, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>): void;
2817
+ list(callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>): void;
2818
+ }
2819
+ export interface Params$Resource$Customers$Telemetry$Users$Get extends StandardParameters {
2820
+ /**
2821
+ * Required. Name of the `TelemetryUser` to return.
2822
+ */
2823
+ name?: string;
2824
+ /**
2825
+ * Read mask to specify which fields to return.
2826
+ */
2827
+ readMask?: string;
2828
+ }
2829
+ export interface Params$Resource$Customers$Telemetry$Users$List extends StandardParameters {
2830
+ /**
2831
+ * Only include resources that match the filter. Supported filter fields: - user_id - user_org_unit_id
2832
+ */
2833
+ filter?: string;
2834
+ /**
2835
+ * Maximum number of results to return. Default value is 100. Maximum value is 1000.
2836
+ */
2837
+ pageSize?: number;
2838
+ /**
2839
+ * Token to specify next page in the list.
2840
+ */
2841
+ pageToken?: string;
2842
+ /**
2843
+ * Required. Customer id or "my_customer" to use the customer associated to the account making the request.
2844
+ */
2845
+ parent?: string;
2846
+ /**
2847
+ * Read mask to specify which fields to return.
2848
+ */
2849
+ readMask?: string;
2850
+ }
2367
2851
  export {};
2368
2852
  }