@maxim_mazurok/gapi.client.admin-reports_v1 0.0.20230425 → 0.0.20230516

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 (3) hide show
  1. package/index.d.ts +723 -424
  2. package/package.json +1 -1
  3. package/tests.ts +1 -1
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://admin.googleapis.com/$discovery/rest?version=reports_v1
12
- // Revision: 20230425
12
+ // Revision: 20230516
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -24,259 +24,358 @@ declare namespace gapi.client {
24
24
  namespace admin {
25
25
  interface Activities {
26
26
  /** ETag of the resource. */
27
- etag?: string;
27
+ etag?:
28
+ string;
28
29
  /** Each activity record in the response. */
29
- items?: Activity[];
30
+ items?:
31
+ Activity[];
30
32
  /** The type of API resource. For an activity report, the value is `reports#activities`. */
31
- kind?: string;
33
+ kind?:
34
+ string;
32
35
  /** Token for retrieving the follow-on next page of the report. The `nextPageToken` value is used in the request's `pageToken` query string. */
33
- nextPageToken?: string;
36
+ nextPageToken?:
37
+ string;
34
38
  }
35
39
  interface Activity {
36
40
  /** User doing the action. */
37
- actor?: {
38
- /** The type of actor. */
39
- callerType?: string;
40
- /** The primary email address of the actor. May be absent if there is no email address associated with the actor. */
41
- email?: string;
42
- /** Only present when `callerType` is `KEY`. Can be the `consumer_key` of the requestor for OAuth 2LO API requests or an identifier for robot accounts. */
43
- key?: string;
44
- /**
45
- * The unique Google Workspace profile ID of the actor. This value might be absent if the actor is not a Google Workspace user, or may be the number 105250506097979753968 which
46
- * acts as a placeholder ID.
47
- */
48
- profileId?: string;
49
- };
41
+ actor?:
42
+ {
43
+ /** The type of actor. */
44
+ callerType?:
45
+ string;
46
+ /** The primary email address of the actor. May be absent if there is no email address associated with the actor. */
47
+ email?:
48
+ string;
49
+ /** Only present when `callerType` is `KEY`. Can be the `consumer_key` of the requestor for OAuth 2LO API requests or an identifier for robot accounts. */
50
+ key?:
51
+ string;
52
+ /**
53
+ * The unique Google Workspace profile ID of the actor. This value might be absent if the actor is not a Google Workspace user, or may be the number 105250506097979753968 which
54
+ * acts as a placeholder ID.
55
+ */
56
+ profileId?:
57
+ string;
58
+ };
50
59
  /** ETag of the entry. */
51
- etag?: string;
60
+ etag?:
61
+ string;
52
62
  /** Activity events in the report. */
53
- events?: Array<{
54
- /**
55
- * Name of the event. This is the specific name of the activity reported by the API. And each `eventName` is related to a specific Google Workspace service or feature which the API
56
- * organizes into types of events. For `eventName` request parameters in general: - If no `eventName` is given, the report returns all possible instances of an `eventName`. - When
57
- * you request an `eventName`, the API's response returns all activities which contain that `eventName`. It is possible that the returned activities will have other `eventName`
58
- * properties in addition to the one requested. For more information about `eventName` properties, see the list of event names for various applications above in `applicationName`.
59
- */
60
- name?: string;
61
- /**
62
- * Parameter value pairs for various applications. For more information about `eventName` parameters, see the list of event names for various applications above in
63
- * `applicationName`.
64
- */
65
- parameters?: Array<{
66
- /** Boolean value of the parameter. */
67
- boolValue?: boolean;
68
- /** Integer value of the parameter. */
69
- intValue?: string;
63
+ events?:
64
+ Array<{
65
+ /**
66
+ * Name of the event. This is the specific name of the activity reported by the API. And each `eventName` is related to a specific Google Workspace service or feature which the
67
+ * API organizes into types of events. For `eventName` request parameters in general: - If no `eventName` is given, the report returns all possible instances of an `eventName`.
68
+ * - When you request an `eventName`, the API's response returns all activities which contain that `eventName`. It is possible that the returned activities will have other
69
+ * `eventName` properties in addition to the one requested. For more information about `eventName` properties, see the list of event names for various applications above in
70
+ * `applicationName`.
71
+ */
72
+ name?:
73
+ string;
70
74
  /**
71
- * Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address
72
- * parameter may have a value as `[{parameter: [{name: city, value: abc}]}]`
75
+ * Parameter value pairs for various applications. For more information about `eventName` parameters, see the list of event names for various applications above in
76
+ * `applicationName`.
73
77
  */
74
- messageValue?: {
75
- /** Parameter values */
76
- parameter?: NestedParameter[];
77
- };
78
- /** Integer values of the parameter. */
79
- multiIntValue?: string[];
80
- /** List of `messageValue` objects. */
81
- multiMessageValue?: Array<{
82
- /** Parameter values */
83
- parameter?: NestedParameter[];
84
- }>;
85
- /** String values of the parameter. */
86
- multiValue?: string[];
87
- /** The name of the parameter. */
88
- name?: string;
89
- /** String value of the parameter. */
90
- value?: string;
78
+ parameters?:
79
+ Array<{
80
+ /** Boolean value of the parameter. */
81
+ boolValue?:
82
+ boolean;
83
+ /** Integer value of the parameter. */
84
+ intValue?:
85
+ string;
86
+ /**
87
+ * Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address
88
+ * parameter may have a value as `[{parameter: [{name: city, value: abc}]}]`
89
+ */
90
+ messageValue?:
91
+ {
92
+ /** Parameter values */
93
+ parameter?:
94
+ NestedParameter[];
95
+ };
96
+ /** Integer values of the parameter. */
97
+ multiIntValue?:
98
+ string[];
99
+ /** List of `messageValue` objects. */
100
+ multiMessageValue?:
101
+ Array<{
102
+ /** Parameter values */
103
+ parameter?:
104
+ NestedParameter[];
105
+ }>;
106
+ /** String values of the parameter. */
107
+ multiValue?:
108
+ string[];
109
+ /** The name of the parameter. */
110
+ name?:
111
+ string;
112
+ /** String value of the parameter. */
113
+ value?:
114
+ string;
115
+ }>;
116
+ /**
117
+ * Type of event. The Google Workspace service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName`
118
+ * property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`.
119
+ */
120
+ type?:
121
+ string;
91
122
  }>;
92
- /**
93
- * Type of event. The Google Workspace service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName`
94
- * property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`.
95
- */
96
- type?: string;
97
- }>;
98
123
  /** Unique identifier for each activity record. */
99
- id?: {
100
- /** Application name to which the event belongs. For possible values see the list of applications above in `applicationName`. */
101
- applicationName?: string;
102
- /** The unique identifier for a Google Workspace account. */
103
- customerId?: string;
104
- /** Time of occurrence of the activity. This is in UNIX epoch time in seconds. */
105
- time?: string;
106
- /** Unique qualifier if multiple events have the same time. */
107
- uniqueQualifier?: string;
108
- };
124
+ id?:
125
+ {
126
+ /** Application name to which the event belongs. For possible values see the list of applications above in `applicationName`. */
127
+ applicationName?:
128
+ string;
129
+ /** The unique identifier for a Google Workspace account. */
130
+ customerId?:
131
+ string;
132
+ /** Time of occurrence of the activity. This is in UNIX epoch time in seconds. */
133
+ time?:
134
+ string;
135
+ /** Unique qualifier if multiple events have the same time. */
136
+ uniqueQualifier?:
137
+ string;
138
+ };
109
139
  /**
110
140
  * IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into Google Workspace, which may or may not reflect the user's physical
111
141
  * location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6.
112
142
  */
113
- ipAddress?: string;
143
+ ipAddress?:
144
+ string;
114
145
  /** The type of API resource. For an activity report, the value is `audit#activity`. */
115
- kind?: string;
146
+ kind?:
147
+ string;
116
148
  /** This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner. */
117
- ownerDomain?: string;
149
+ ownerDomain?:
150
+ string;
118
151
  }
119
152
  interface Channel {
120
153
  /** The address where notifications are delivered for this channel. */
121
- address?: string;
154
+ address?:
155
+ string;
122
156
  /** Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */
123
- expiration?: string;
157
+ expiration?:
158
+ string;
124
159
  /** A UUID or similar unique string that identifies this channel. */
125
- id?: string;
160
+ id?:
161
+ string;
126
162
  /** Identifies this as a notification channel used to watch for changes to a resource, which is "`api#channel`". */
127
- kind?: string;
163
+ kind?:
164
+ string;
128
165
  /** Additional parameters controlling delivery channel behavior. Optional. */
129
- params?: { [P in string]: string };
166
+ params?:
167
+ { [P in string]: string };
130
168
  /**
131
169
  * A Boolean value to indicate whether payload is wanted. A payload is data that is sent in the body of an HTTP POST, PUT, or PATCH message and contains important information about the
132
170
  * request. Optional.
133
171
  */
134
- payload?: boolean;
172
+ payload?:
173
+ boolean;
135
174
  /** An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */
136
- resourceId?: string;
175
+ resourceId?:
176
+ string;
137
177
  /** A version-specific identifier for the watched resource. */
138
- resourceUri?: string;
178
+ resourceUri?:
179
+ string;
139
180
  /** An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */
140
- token?: string;
181
+ token?:
182
+ string;
141
183
  /** The type of delivery mechanism used for this channel. The value should be set to `"web_hook"`. */
142
- type?: string;
184
+ type?:
185
+ string;
143
186
  }
144
187
  interface NestedParameter {
145
188
  /** Boolean value of the parameter. */
146
- boolValue?: boolean;
189
+ boolValue?:
190
+ boolean;
147
191
  /** Integer value of the parameter. */
148
- intValue?: string;
192
+ intValue?:
193
+ string;
149
194
  /** Multiple boolean values of the parameter. */
150
- multiBoolValue?: boolean[];
195
+ multiBoolValue?:
196
+ boolean[];
151
197
  /** Multiple integer values of the parameter. */
152
- multiIntValue?: string[];
198
+ multiIntValue?:
199
+ string[];
153
200
  /** Multiple string values of the parameter. */
154
- multiValue?: string[];
201
+ multiValue?:
202
+ string[];
155
203
  /** The name of the parameter. */
156
- name?: string;
204
+ name?:
205
+ string;
157
206
  /** String value of the parameter. */
158
- value?: string;
207
+ value?:
208
+ string;
159
209
  }
160
210
  interface UsageReport {
161
211
  /** Output only. The date of the report request. */
162
- date?: string;
212
+ date?:
213
+ string;
163
214
  /** Output only. Information about the type of the item. */
164
- entity?: {
165
- /** Output only. The unique identifier of the customer's account. */
166
- customerId?: string;
167
- /** Output only. Object key. Only relevant if entity.type = "OBJECT" Note: external-facing name of report is "Entities" rather than "Objects". */
168
- entityId?: string;
169
- /** Output only. The user's immutable Google Workspace profile identifier. */
170
- profileId?: string;
171
- /** Output only. The type of item. The value is `user`. */
172
- type?: string;
173
- /** Output only. The user's email address. Only relevant if entity.type = "USER" */
174
- userEmail?: string;
175
- };
215
+ entity?:
216
+ {
217
+ /** Output only. The unique identifier of the customer's account. */
218
+ customerId?:
219
+ string;
220
+ /** Output only. Object key. Only relevant if entity.type = "OBJECT" Note: external-facing name of report is "Entities" rather than "Objects". */
221
+ entityId?:
222
+ string;
223
+ /** Output only. The user's immutable Google Workspace profile identifier. */
224
+ profileId?:
225
+ string;
226
+ /** Output only. The type of item. The value is `user`. */
227
+ type?:
228
+ string;
229
+ /** Output only. The user's email address. Only relevant if entity.type = "USER" */
230
+ userEmail?:
231
+ string;
232
+ };
176
233
  /** ETag of the resource. */
177
- etag?: string;
234
+ etag?:
235
+ string;
178
236
  /** The type of API resource. For a usage report, the value is `admin#reports#usageReport`. */
179
- kind?: string;
237
+ kind?:
238
+ string;
180
239
  /**
181
240
  * Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters
182
241
  * reference](/admin-sdk/reports/v1/reference/usage-ref-appendix-a/entities).
183
242
  */
184
- parameters?: Array<{
185
- /** Output only. Boolean value of the parameter. */
186
- boolValue?: boolean;
187
- /** The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z. */
188
- datetimeValue?: string;
189
- /** Output only. Integer value of the parameter. */
190
- intValue?: string;
191
- /** Output only. Nested message value of the parameter. */
192
- msgValue?: Array<{ [P in string]: any }>;
193
- /** The name of the parameter. For the User Usage Report parameter names, see the User Usage parameters reference. */
194
- name?: string;
195
- /** Output only. String value of the parameter. */
196
- stringValue?: string;
197
- }>;
243
+ parameters?:
244
+ Array<{
245
+ /** Output only. Boolean value of the parameter. */
246
+ boolValue?:
247
+ boolean;
248
+ /** The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z. */
249
+ datetimeValue?:
250
+ string;
251
+ /** Output only. Integer value of the parameter. */
252
+ intValue?:
253
+ string;
254
+ /** Output only. Nested message value of the parameter. */
255
+ msgValue?:
256
+ Array<{ [P in string]: any }>;
257
+ /** The name of the parameter. For the User Usage Report parameter names, see the User Usage parameters reference. */
258
+ name?:
259
+ string;
260
+ /** Output only. String value of the parameter. */
261
+ stringValue?:
262
+ string;
263
+ }>;
198
264
  }
199
265
  interface UsageReports {
200
266
  /** ETag of the resource. */
201
- etag?: string;
267
+ etag?:
268
+ string;
202
269
  /** The type of API resource. For a usage report, the value is `admin#reports#usageReports`. */
203
- kind?: string;
270
+ kind?:
271
+ string;
204
272
  /**
205
273
  * Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests getting all of the report's pages, enter the
206
274
  * `nextPageToken` value in the `pageToken` query string.
207
275
  */
208
- nextPageToken?: string;
276
+ nextPageToken?:
277
+ string;
209
278
  /** Various application parameter records. */
210
- usageReports?: UsageReport[];
279
+ usageReports?:
280
+ UsageReport[];
211
281
  /** Warnings, if any. */
212
- warnings?: Array<{
213
- /** Machine readable code or warning type. The warning code value is `200`. */
214
- code?: string;
215
- /** Key-value pairs to give detailed information on the warning. */
216
- data?: Array<{
217
- /** Key associated with a key-value pair to give detailed information on the warning. */
218
- key?: string;
219
- /** Value associated with a key-value pair to give detailed information on the warning. */
220
- value?: string;
282
+ warnings?:
283
+ Array<{
284
+ /** Machine readable code or warning type. The warning code value is `200`. */
285
+ code?:
286
+ string;
287
+ /** Key-value pairs to give detailed information on the warning. */
288
+ data?:
289
+ Array<{
290
+ /** Key associated with a key-value pair to give detailed information on the warning. */
291
+ key?:
292
+ string;
293
+ /** Value associated with a key-value pair to give detailed information on the warning. */
294
+ value?:
295
+ string;
296
+ }>;
297
+ /**
298
+ * The human readable messages for a warning are: - Data is not available warning - Sorry, data for date yyyy-mm-dd for application "`application name`" is not available. -
299
+ * Partial data is available warning - Data for date yyyy-mm-dd for application "`application name`" is not available right now, please try again after a few hours.
300
+ */
301
+ message?:
302
+ string;
221
303
  }>;
222
- /**
223
- * The human readable messages for a warning are: - Data is not available warning - Sorry, data for date yyyy-mm-dd for application "`application name`" is not available. - Partial
224
- * data is available warning - Data for date yyyy-mm-dd for application "`application name`" is not available right now, please try again after a few hours.
225
- */
226
- message?: string;
227
- }>;
228
304
  }
229
305
  interface ChannelsResource {
230
306
  /** Stop watching resources through this channel. */
231
307
  stop(request: {
232
308
  /** V1 error format. */
233
- "$.xgafv"?: string;
309
+ "$.xgafv"?:
310
+ string;
234
311
  /** OAuth access token. */
235
- access_token?: string;
312
+ access_token?:
313
+ string;
236
314
  /** Data format for response. */
237
- alt?: string;
315
+ alt?:
316
+ string;
238
317
  /** JSONP */
239
- callback?: string;
318
+ callback?:
319
+ string;
240
320
  /** Selector specifying which fields to include in a partial response. */
241
- fields?: string;
321
+ fields?:
322
+ string;
242
323
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
243
- key?: string;
324
+ key?:
325
+ string;
244
326
  /** OAuth 2.0 token for the current user. */
245
- oauth_token?: string;
327
+ oauth_token?:
328
+ string;
246
329
  /** Returns response with indentations and line breaks. */
247
- prettyPrint?: boolean;
330
+ prettyPrint?:
331
+ boolean;
248
332
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
249
- quotaUser?: string;
333
+ quotaUser?:
334
+ string;
250
335
  /** Upload protocol for media (e.g. "raw", "multipart"). */
251
- upload_protocol?: string;
336
+ upload_protocol?:
337
+ string;
252
338
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
253
- uploadType?: string;
339
+ uploadType?:
340
+ string;
254
341
  /** Request body */
255
- resource: Channel;
342
+ resource:
343
+ Channel;
256
344
  }): Request<void>;
257
345
  stop(request: {
258
346
  /** V1 error format. */
259
- "$.xgafv"?: string;
347
+ "$.xgafv"?:
348
+ string;
260
349
  /** OAuth access token. */
261
- access_token?: string;
350
+ access_token?:
351
+ string;
262
352
  /** Data format for response. */
263
- alt?: string;
353
+ alt?:
354
+ string;
264
355
  /** JSONP */
265
- callback?: string;
356
+ callback?:
357
+ string;
266
358
  /** Selector specifying which fields to include in a partial response. */
267
- fields?: string;
359
+ fields?:
360
+ string;
268
361
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
269
- key?: string;
362
+ key?:
363
+ string;
270
364
  /** OAuth 2.0 token for the current user. */
271
- oauth_token?: string;
365
+ oauth_token?:
366
+ string;
272
367
  /** Returns response with indentations and line breaks. */
273
- prettyPrint?: boolean;
368
+ prettyPrint?:
369
+ boolean;
274
370
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
275
- quotaUser?: string;
371
+ quotaUser?:
372
+ string;
276
373
  /** Upload protocol for media (e.g. "raw", "multipart"). */
277
- upload_protocol?: string;
374
+ upload_protocol?:
375
+ string;
278
376
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
279
- uploadType?: string;
377
+ uploadType?:
378
+ string;
280
379
  },
281
380
  body: Channel): Request<void>;
282
381
  }
@@ -286,207 +385,283 @@ declare namespace gapi.client {
286
385
  namespace reports {
287
386
  interface Activities {
288
387
  /** ETag of the resource. */
289
- etag?: string;
388
+ etag?:
389
+ string;
290
390
  /** Each activity record in the response. */
291
- items?: Activity[];
391
+ items?:
392
+ Activity[];
292
393
  /** The type of API resource. For an activity report, the value is `reports#activities`. */
293
- kind?: string;
394
+ kind?:
395
+ string;
294
396
  /** Token for retrieving the follow-on next page of the report. The `nextPageToken` value is used in the request's `pageToken` query string. */
295
- nextPageToken?: string;
397
+ nextPageToken?:
398
+ string;
296
399
  }
297
400
  interface Activity {
298
401
  /** User doing the action. */
299
- actor?: {
300
- /** The type of actor. */
301
- callerType?: string;
302
- /** The primary email address of the actor. May be absent if there is no email address associated with the actor. */
303
- email?: string;
304
- /** Only present when `callerType` is `KEY`. Can be the `consumer_key` of the requestor for OAuth 2LO API requests or an identifier for robot accounts. */
305
- key?: string;
306
- /**
307
- * The unique Google Workspace profile ID of the actor. This value might be absent if the actor is not a Google Workspace user, or may be the number 105250506097979753968 which
308
- * acts as a placeholder ID.
309
- */
310
- profileId?: string;
311
- };
402
+ actor?:
403
+ {
404
+ /** The type of actor. */
405
+ callerType?:
406
+ string;
407
+ /** The primary email address of the actor. May be absent if there is no email address associated with the actor. */
408
+ email?:
409
+ string;
410
+ /** Only present when `callerType` is `KEY`. Can be the `consumer_key` of the requestor for OAuth 2LO API requests or an identifier for robot accounts. */
411
+ key?:
412
+ string;
413
+ /**
414
+ * The unique Google Workspace profile ID of the actor. This value might be absent if the actor is not a Google Workspace user, or may be the number 105250506097979753968 which
415
+ * acts as a placeholder ID.
416
+ */
417
+ profileId?:
418
+ string;
419
+ };
312
420
  /** ETag of the entry. */
313
- etag?: string;
421
+ etag?:
422
+ string;
314
423
  /** Activity events in the report. */
315
- events?: Array<{
316
- /**
317
- * Name of the event. This is the specific name of the activity reported by the API. And each `eventName` is related to a specific Google Workspace service or feature which the API
318
- * organizes into types of events. For `eventName` request parameters in general: - If no `eventName` is given, the report returns all possible instances of an `eventName`. - When
319
- * you request an `eventName`, the API's response returns all activities which contain that `eventName`. It is possible that the returned activities will have other `eventName`
320
- * properties in addition to the one requested. For more information about `eventName` properties, see the list of event names for various applications above in `applicationName`.
321
- */
322
- name?: string;
323
- /**
324
- * Parameter value pairs for various applications. For more information about `eventName` parameters, see the list of event names for various applications above in
325
- * `applicationName`.
326
- */
327
- parameters?: Array<{
328
- /** Boolean value of the parameter. */
329
- boolValue?: boolean;
330
- /** Integer value of the parameter. */
331
- intValue?: string;
424
+ events?:
425
+ Array<{
426
+ /**
427
+ * Name of the event. This is the specific name of the activity reported by the API. And each `eventName` is related to a specific Google Workspace service or feature which the
428
+ * API organizes into types of events. For `eventName` request parameters in general: - If no `eventName` is given, the report returns all possible instances of an `eventName`.
429
+ * - When you request an `eventName`, the API's response returns all activities which contain that `eventName`. It is possible that the returned activities will have other
430
+ * `eventName` properties in addition to the one requested. For more information about `eventName` properties, see the list of event names for various applications above in
431
+ * `applicationName`.
432
+ */
433
+ name?:
434
+ string;
332
435
  /**
333
- * Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address
334
- * parameter may have a value as `[{parameter: [{name: city, value: abc}]}]`
436
+ * Parameter value pairs for various applications. For more information about `eventName` parameters, see the list of event names for various applications above in
437
+ * `applicationName`.
335
438
  */
336
- messageValue?: {
337
- /** Parameter values */
338
- parameter?: NestedParameter[];
339
- };
340
- /** Integer values of the parameter. */
341
- multiIntValue?: string[];
342
- /** List of `messageValue` objects. */
343
- multiMessageValue?: Array<{
344
- /** Parameter values */
345
- parameter?: NestedParameter[];
346
- }>;
347
- /** String values of the parameter. */
348
- multiValue?: string[];
349
- /** The name of the parameter. */
350
- name?: string;
351
- /** String value of the parameter. */
352
- value?: string;
439
+ parameters?:
440
+ Array<{
441
+ /** Boolean value of the parameter. */
442
+ boolValue?:
443
+ boolean;
444
+ /** Integer value of the parameter. */
445
+ intValue?:
446
+ string;
447
+ /**
448
+ * Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address
449
+ * parameter may have a value as `[{parameter: [{name: city, value: abc}]}]`
450
+ */
451
+ messageValue?:
452
+ {
453
+ /** Parameter values */
454
+ parameter?:
455
+ NestedParameter[];
456
+ };
457
+ /** Integer values of the parameter. */
458
+ multiIntValue?:
459
+ string[];
460
+ /** List of `messageValue` objects. */
461
+ multiMessageValue?:
462
+ Array<{
463
+ /** Parameter values */
464
+ parameter?:
465
+ NestedParameter[];
466
+ }>;
467
+ /** String values of the parameter. */
468
+ multiValue?:
469
+ string[];
470
+ /** The name of the parameter. */
471
+ name?:
472
+ string;
473
+ /** String value of the parameter. */
474
+ value?:
475
+ string;
476
+ }>;
477
+ /**
478
+ * Type of event. The Google Workspace service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName`
479
+ * property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`.
480
+ */
481
+ type?:
482
+ string;
353
483
  }>;
354
- /**
355
- * Type of event. The Google Workspace service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName`
356
- * property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`.
357
- */
358
- type?: string;
359
- }>;
360
484
  /** Unique identifier for each activity record. */
361
- id?: {
362
- /** Application name to which the event belongs. For possible values see the list of applications above in `applicationName`. */
363
- applicationName?: string;
364
- /** The unique identifier for a Google Workspace account. */
365
- customerId?: string;
366
- /** Time of occurrence of the activity. This is in UNIX epoch time in seconds. */
367
- time?: string;
368
- /** Unique qualifier if multiple events have the same time. */
369
- uniqueQualifier?: string;
370
- };
485
+ id?:
486
+ {
487
+ /** Application name to which the event belongs. For possible values see the list of applications above in `applicationName`. */
488
+ applicationName?:
489
+ string;
490
+ /** The unique identifier for a Google Workspace account. */
491
+ customerId?:
492
+ string;
493
+ /** Time of occurrence of the activity. This is in UNIX epoch time in seconds. */
494
+ time?:
495
+ string;
496
+ /** Unique qualifier if multiple events have the same time. */
497
+ uniqueQualifier?:
498
+ string;
499
+ };
371
500
  /**
372
501
  * IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into Google Workspace, which may or may not reflect the user's physical
373
502
  * location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6.
374
503
  */
375
- ipAddress?: string;
504
+ ipAddress?:
505
+ string;
376
506
  /** The type of API resource. For an activity report, the value is `audit#activity`. */
377
- kind?: string;
507
+ kind?:
508
+ string;
378
509
  /** This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner. */
379
- ownerDomain?: string;
510
+ ownerDomain?:
511
+ string;
380
512
  }
381
513
  interface Channel {
382
514
  /** The address where notifications are delivered for this channel. */
383
- address?: string;
515
+ address?:
516
+ string;
384
517
  /** Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */
385
- expiration?: string;
518
+ expiration?:
519
+ string;
386
520
  /** A UUID or similar unique string that identifies this channel. */
387
- id?: string;
521
+ id?:
522
+ string;
388
523
  /** Identifies this as a notification channel used to watch for changes to a resource, which is "`api#channel`". */
389
- kind?: string;
524
+ kind?:
525
+ string;
390
526
  /** Additional parameters controlling delivery channel behavior. Optional. */
391
- params?: { [P in string]: string };
527
+ params?:
528
+ { [P in string]: string };
392
529
  /**
393
530
  * A Boolean value to indicate whether payload is wanted. A payload is data that is sent in the body of an HTTP POST, PUT, or PATCH message and contains important information about the
394
531
  * request. Optional.
395
532
  */
396
- payload?: boolean;
533
+ payload?:
534
+ boolean;
397
535
  /** An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */
398
- resourceId?: string;
536
+ resourceId?:
537
+ string;
399
538
  /** A version-specific identifier for the watched resource. */
400
- resourceUri?: string;
539
+ resourceUri?:
540
+ string;
401
541
  /** An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */
402
- token?: string;
542
+ token?:
543
+ string;
403
544
  /** The type of delivery mechanism used for this channel. The value should be set to `"web_hook"`. */
404
- type?: string;
545
+ type?:
546
+ string;
405
547
  }
406
548
  interface NestedParameter {
407
549
  /** Boolean value of the parameter. */
408
- boolValue?: boolean;
550
+ boolValue?:
551
+ boolean;
409
552
  /** Integer value of the parameter. */
410
- intValue?: string;
553
+ intValue?:
554
+ string;
411
555
  /** Multiple boolean values of the parameter. */
412
- multiBoolValue?: boolean[];
556
+ multiBoolValue?:
557
+ boolean[];
413
558
  /** Multiple integer values of the parameter. */
414
- multiIntValue?: string[];
559
+ multiIntValue?:
560
+ string[];
415
561
  /** Multiple string values of the parameter. */
416
- multiValue?: string[];
562
+ multiValue?:
563
+ string[];
417
564
  /** The name of the parameter. */
418
- name?: string;
565
+ name?:
566
+ string;
419
567
  /** String value of the parameter. */
420
- value?: string;
568
+ value?:
569
+ string;
421
570
  }
422
571
  interface UsageReport {
423
572
  /** Output only. The date of the report request. */
424
- date?: string;
573
+ date?:
574
+ string;
425
575
  /** Output only. Information about the type of the item. */
426
- entity?: {
427
- /** Output only. The unique identifier of the customer's account. */
428
- customerId?: string;
429
- /** Output only. Object key. Only relevant if entity.type = "OBJECT" Note: external-facing name of report is "Entities" rather than "Objects". */
430
- entityId?: string;
431
- /** Output only. The user's immutable Google Workspace profile identifier. */
432
- profileId?: string;
433
- /** Output only. The type of item. The value is `user`. */
434
- type?: string;
435
- /** Output only. The user's email address. Only relevant if entity.type = "USER" */
436
- userEmail?: string;
437
- };
576
+ entity?:
577
+ {
578
+ /** Output only. The unique identifier of the customer's account. */
579
+ customerId?:
580
+ string;
581
+ /** Output only. Object key. Only relevant if entity.type = "OBJECT" Note: external-facing name of report is "Entities" rather than "Objects". */
582
+ entityId?:
583
+ string;
584
+ /** Output only. The user's immutable Google Workspace profile identifier. */
585
+ profileId?:
586
+ string;
587
+ /** Output only. The type of item. The value is `user`. */
588
+ type?:
589
+ string;
590
+ /** Output only. The user's email address. Only relevant if entity.type = "USER" */
591
+ userEmail?:
592
+ string;
593
+ };
438
594
  /** ETag of the resource. */
439
- etag?: string;
595
+ etag?:
596
+ string;
440
597
  /** The type of API resource. For a usage report, the value is `admin#reports#usageReport`. */
441
- kind?: string;
598
+ kind?:
599
+ string;
442
600
  /**
443
601
  * Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters
444
602
  * reference](/admin-sdk/reports/v1/reference/usage-ref-appendix-a/entities).
445
603
  */
446
- parameters?: Array<{
447
- /** Output only. Boolean value of the parameter. */
448
- boolValue?: boolean;
449
- /** The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z. */
450
- datetimeValue?: string;
451
- /** Output only. Integer value of the parameter. */
452
- intValue?: string;
453
- /** Output only. Nested message value of the parameter. */
454
- msgValue?: Array<{ [P in string]: any }>;
455
- /** The name of the parameter. For the User Usage Report parameter names, see the User Usage parameters reference. */
456
- name?: string;
457
- /** Output only. String value of the parameter. */
458
- stringValue?: string;
459
- }>;
604
+ parameters?:
605
+ Array<{
606
+ /** Output only. Boolean value of the parameter. */
607
+ boolValue?:
608
+ boolean;
609
+ /** The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z. */
610
+ datetimeValue?:
611
+ string;
612
+ /** Output only. Integer value of the parameter. */
613
+ intValue?:
614
+ string;
615
+ /** Output only. Nested message value of the parameter. */
616
+ msgValue?:
617
+ Array<{ [P in string]: any }>;
618
+ /** The name of the parameter. For the User Usage Report parameter names, see the User Usage parameters reference. */
619
+ name?:
620
+ string;
621
+ /** Output only. String value of the parameter. */
622
+ stringValue?:
623
+ string;
624
+ }>;
460
625
  }
461
626
  interface UsageReports {
462
627
  /** ETag of the resource. */
463
- etag?: string;
628
+ etag?:
629
+ string;
464
630
  /** The type of API resource. For a usage report, the value is `admin#reports#usageReports`. */
465
- kind?: string;
631
+ kind?:
632
+ string;
466
633
  /**
467
634
  * Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests getting all of the report's pages, enter the
468
635
  * `nextPageToken` value in the `pageToken` query string.
469
636
  */
470
- nextPageToken?: string;
637
+ nextPageToken?:
638
+ string;
471
639
  /** Various application parameter records. */
472
- usageReports?: UsageReport[];
640
+ usageReports?:
641
+ UsageReport[];
473
642
  /** Warnings, if any. */
474
- warnings?: Array<{
475
- /** Machine readable code or warning type. The warning code value is `200`. */
476
- code?: string;
477
- /** Key-value pairs to give detailed information on the warning. */
478
- data?: Array<{
479
- /** Key associated with a key-value pair to give detailed information on the warning. */
480
- key?: string;
481
- /** Value associated with a key-value pair to give detailed information on the warning. */
482
- value?: string;
643
+ warnings?:
644
+ Array<{
645
+ /** Machine readable code or warning type. The warning code value is `200`. */
646
+ code?:
647
+ string;
648
+ /** Key-value pairs to give detailed information on the warning. */
649
+ data?:
650
+ Array<{
651
+ /** Key associated with a key-value pair to give detailed information on the warning. */
652
+ key?:
653
+ string;
654
+ /** Value associated with a key-value pair to give detailed information on the warning. */
655
+ value?:
656
+ string;
657
+ }>;
658
+ /**
659
+ * The human readable messages for a warning are: - Data is not available warning - Sorry, data for date yyyy-mm-dd for application "`application name`" is not available. -
660
+ * Partial data is available warning - Data for date yyyy-mm-dd for application "`application name`" is not available right now, please try again after a few hours.
661
+ */
662
+ message?:
663
+ string;
483
664
  }>;
484
- /**
485
- * The human readable messages for a warning are: - Data is not available warning - Sorry, data for date yyyy-mm-dd for application "`application name`" is not available. - Partial
486
- * data is available warning - Data for date yyyy-mm-dd for application "`application name`" is not available right now, please try again after a few hours.
487
- */
488
- message?: string;
489
- }>;
490
665
  }
491
666
  interface ActivitiesResource {
492
667
  /**
@@ -495,23 +670,30 @@ declare namespace gapi.client {
495
670
  */
496
671
  list(request?: {
497
672
  /** V1 error format. */
498
- "$.xgafv"?: string;
673
+ "$.xgafv"?:
674
+ string;
499
675
  /** OAuth access token. */
500
- access_token?: string;
676
+ access_token?:
677
+ string;
501
678
  /**
502
679
  * The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity
503
680
  * is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private
504
681
  * network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.
505
682
  */
506
- actorIpAddress?: string;
683
+ actorIpAddress?:
684
+ string;
507
685
  /** Data format for response. */
508
- alt?: string;
686
+ alt?:
687
+ string;
509
688
  /** Application name for which the events are to be retrieved. */
510
- applicationName: string;
689
+ applicationName:
690
+ string;
511
691
  /** JSONP */
512
- callback?: string;
692
+ callback?:
693
+ string;
513
694
  /** The unique ID of the customer to retrieve data for. */
514
- customerId?: string;
695
+ customerId?:
696
+ string;
515
697
  /**
516
698
  * Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the
517
699
  * API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The
@@ -520,16 +702,19 @@ declare namespace gapi.client {
520
702
  * report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180
521
703
  * days if the `startTime` is more than 180 days in the past.
522
704
  */
523
- endTime?: string;
705
+ endTime?:
706
+ string;
524
707
  /**
525
708
  * The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An
526
709
  * example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported
527
710
  * by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information
528
711
  * about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.
529
712
  */
530
- eventName?: string;
713
+ eventName?:
714
+ string;
531
715
  /** Selector specifying which fields to include in a partial response. */
532
- fields?: string;
716
+ fields?:
717
+ string;
533
718
  /**
534
719
  * The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1
535
720
  * name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` These event parameters are associated with a specific `eventName`. An
@@ -544,71 +729,91 @@ declare namespace gapi.client {
544
729
  * the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and
545
730
  * returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned.
546
731
  */
547
- filters?: string;
732
+ filters?:
733
+ string;
548
734
  /**
549
735
  * Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of
550
736
  * the group ids mentioned here. Format: "id:abc123,id:xyz456"
551
737
  */
552
- groupIdFilter?: string;
738
+ groupIdFilter?:
739
+ string;
553
740
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
554
- key?: string;
741
+ key?:
742
+ string;
555
743
  /**
556
744
  * Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two
557
745
  * pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.
558
746
  */
559
- maxResults?: number;
747
+ maxResults?:
748
+ number;
560
749
  /** OAuth 2.0 token for the current user. */
561
- oauth_token?: string;
750
+ oauth_token?:
751
+ string;
562
752
  /**
563
753
  * ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't
564
754
  * appear in the filtered results.
565
755
  */
566
- orgUnitID?: string;
756
+ orgUnitID?:
757
+ string;
567
758
  /**
568
759
  * The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter
569
760
  * the `nextPageToken` value in the `pageToken` query string.
570
761
  */
571
- pageToken?: string;
762
+ pageToken?:
763
+ string;
572
764
  /** Returns response with indentations and line breaks. */
573
- prettyPrint?: boolean;
765
+ prettyPrint?:
766
+ boolean;
574
767
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
575
- quotaUser?: string;
768
+ quotaUser?:
769
+ string;
576
770
  /**
577
771
  * Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from
578
772
  * `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error.
579
773
  */
580
- startTime?: string;
774
+ startTime?:
775
+ string;
581
776
  /** Upload protocol for media (e.g. "raw", "multipart"). */
582
- upload_protocol?: string;
777
+ upload_protocol?:
778
+ string;
583
779
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
584
- uploadType?: string;
780
+ uploadType?:
781
+ string;
585
782
  /**
586
783
  * Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID
587
784
  * or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the
588
785
  * `userKey`.
589
786
  */
590
- userKey: string;
787
+ userKey:
788
+ string;
591
789
  }): Request<Activities>;
592
790
  /** Start receiving notifications for account activities. For more information, see Receiving Push Notifications. */
593
791
  watch(request: {
594
792
  /** V1 error format. */
595
- "$.xgafv"?: string;
793
+ "$.xgafv"?:
794
+ string;
596
795
  /** OAuth access token. */
597
- access_token?: string;
796
+ access_token?:
797
+ string;
598
798
  /**
599
799
  * The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity
600
800
  * is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private
601
801
  * network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.
602
802
  */
603
- actorIpAddress?: string;
803
+ actorIpAddress?:
804
+ string;
604
805
  /** Data format for response. */
605
- alt?: string;
806
+ alt?:
807
+ string;
606
808
  /** Application name for which the events are to be retrieved. */
607
- applicationName: string;
809
+ applicationName:
810
+ string;
608
811
  /** JSONP */
609
- callback?: string;
812
+ callback?:
813
+ string;
610
814
  /** The unique ID of the customer to retrieve data for. */
611
- customerId?: string;
815
+ customerId?:
816
+ string;
612
817
  /**
613
818
  * Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the
614
819
  * API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The
@@ -617,16 +822,19 @@ declare namespace gapi.client {
617
822
  * report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180
618
823
  * days if the `startTime` is more than 180 days in the past.
619
824
  */
620
- endTime?: string;
825
+ endTime?:
826
+ string;
621
827
  /**
622
828
  * The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An
623
829
  * example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported
624
830
  * by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information
625
831
  * about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.
626
832
  */
627
- eventName?: string;
833
+ eventName?:
834
+ string;
628
835
  /** Selector specifying which fields to include in a partial response. */
629
- fields?: string;
836
+ fields?:
837
+ string;
630
838
  /**
631
839
  * The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1
632
840
  * name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` These event parameters are associated with a specific `eventName`. An
@@ -641,72 +849,93 @@ declare namespace gapi.client {
641
849
  * the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and
642
850
  * returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned.
643
851
  */
644
- filters?: string;
852
+ filters?:
853
+ string;
645
854
  /**
646
855
  * Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of
647
856
  * the group ids mentioned here. Format: "id:abc123,id:xyz456"
648
857
  */
649
- groupIdFilter?: string;
858
+ groupIdFilter?:
859
+ string;
650
860
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
651
- key?: string;
861
+ key?:
862
+ string;
652
863
  /**
653
864
  * Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two
654
865
  * pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.
655
866
  */
656
- maxResults?: number;
867
+ maxResults?:
868
+ number;
657
869
  /** OAuth 2.0 token for the current user. */
658
- oauth_token?: string;
870
+ oauth_token?:
871
+ string;
659
872
  /**
660
873
  * ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't
661
874
  * appear in the filtered results.
662
875
  */
663
- orgUnitID?: string;
876
+ orgUnitID?:
877
+ string;
664
878
  /**
665
879
  * The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter
666
880
  * the `nextPageToken` value in the `pageToken` query string.
667
881
  */
668
- pageToken?: string;
882
+ pageToken?:
883
+ string;
669
884
  /** Returns response with indentations and line breaks. */
670
- prettyPrint?: boolean;
885
+ prettyPrint?:
886
+ boolean;
671
887
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
672
- quotaUser?: string;
888
+ quotaUser?:
889
+ string;
673
890
  /**
674
891
  * Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from
675
892
  * `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error.
676
893
  */
677
- startTime?: string;
894
+ startTime?:
895
+ string;
678
896
  /** Upload protocol for media (e.g. "raw", "multipart"). */
679
- upload_protocol?: string;
897
+ upload_protocol?:
898
+ string;
680
899
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
681
- uploadType?: string;
900
+ uploadType?:
901
+ string;
682
902
  /**
683
903
  * Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID
684
904
  * or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the
685
905
  * `userKey`.
686
906
  */
687
- userKey: string;
907
+ userKey:
908
+ string;
688
909
  /** Request body */
689
- resource: Channel;
910
+ resource:
911
+ Channel;
690
912
  }): Request<Channel>;
691
913
  watch(request: {
692
914
  /** V1 error format. */
693
- "$.xgafv"?: string;
915
+ "$.xgafv"?:
916
+ string;
694
917
  /** OAuth access token. */
695
- access_token?: string;
918
+ access_token?:
919
+ string;
696
920
  /**
697
921
  * The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity
698
922
  * is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private
699
923
  * network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.
700
924
  */
701
- actorIpAddress?: string;
925
+ actorIpAddress?:
926
+ string;
702
927
  /** Data format for response. */
703
- alt?: string;
928
+ alt?:
929
+ string;
704
930
  /** Application name for which the events are to be retrieved. */
705
- applicationName: string;
931
+ applicationName:
932
+ string;
706
933
  /** JSONP */
707
- callback?: string;
934
+ callback?:
935
+ string;
708
936
  /** The unique ID of the customer to retrieve data for. */
709
- customerId?: string;
937
+ customerId?:
938
+ string;
710
939
  /**
711
940
  * Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the
712
941
  * API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The
@@ -715,16 +944,19 @@ declare namespace gapi.client {
715
944
  * report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180
716
945
  * days if the `startTime` is more than 180 days in the past.
717
946
  */
718
- endTime?: string;
947
+ endTime?:
948
+ string;
719
949
  /**
720
950
  * The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An
721
951
  * example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported
722
952
  * by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information
723
953
  * about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.
724
954
  */
725
- eventName?: string;
955
+ eventName?:
956
+ string;
726
957
  /** Selector specifying which fields to include in a partial response. */
727
- fields?: string;
958
+ fields?:
959
+ string;
728
960
  /**
729
961
  * The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1
730
962
  * name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` These event parameters are associated with a specific `eventName`. An
@@ -739,50 +971,63 @@ declare namespace gapi.client {
739
971
  * the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and
740
972
  * returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned.
741
973
  */
742
- filters?: string;
974
+ filters?:
975
+ string;
743
976
  /**
744
977
  * Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of
745
978
  * the group ids mentioned here. Format: "id:abc123,id:xyz456"
746
979
  */
747
- groupIdFilter?: string;
980
+ groupIdFilter?:
981
+ string;
748
982
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
749
- key?: string;
983
+ key?:
984
+ string;
750
985
  /**
751
986
  * Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two
752
987
  * pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.
753
988
  */
754
- maxResults?: number;
989
+ maxResults?:
990
+ number;
755
991
  /** OAuth 2.0 token for the current user. */
756
- oauth_token?: string;
992
+ oauth_token?:
993
+ string;
757
994
  /**
758
995
  * ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't
759
996
  * appear in the filtered results.
760
997
  */
761
- orgUnitID?: string;
998
+ orgUnitID?:
999
+ string;
762
1000
  /**
763
1001
  * The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter
764
1002
  * the `nextPageToken` value in the `pageToken` query string.
765
1003
  */
766
- pageToken?: string;
1004
+ pageToken?:
1005
+ string;
767
1006
  /** Returns response with indentations and line breaks. */
768
- prettyPrint?: boolean;
1007
+ prettyPrint?:
1008
+ boolean;
769
1009
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
770
- quotaUser?: string;
1010
+ quotaUser?:
1011
+ string;
771
1012
  /**
772
1013
  * Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from
773
1014
  * `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error.
774
1015
  */
775
- startTime?: string;
1016
+ startTime?:
1017
+ string;
776
1018
  /** Upload protocol for media (e.g. "raw", "multipart"). */
777
- upload_protocol?: string;
1019
+ upload_protocol?:
1020
+ string;
778
1021
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
779
- uploadType?: string;
1022
+ uploadType?:
1023
+ string;
780
1024
  /**
781
1025
  * Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID
782
1026
  * or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the
783
1027
  * `userKey`.
784
1028
  */
785
- userKey: string;
1029
+ userKey:
1030
+ string;
786
1031
  },
787
1032
  body: Channel): Request<Channel>;
788
1033
  }
@@ -793,28 +1038,38 @@ declare namespace gapi.client {
793
1038
  */
794
1039
  get(request?: {
795
1040
  /** V1 error format. */
796
- "$.xgafv"?: string;
1041
+ "$.xgafv"?:
1042
+ string;
797
1043
  /** OAuth access token. */
798
- access_token?: string;
1044
+ access_token?:
1045
+ string;
799
1046
  /** Data format for response. */
800
- alt?: string;
1047
+ alt?:
1048
+ string;
801
1049
  /** JSONP */
802
- callback?: string;
1050
+ callback?:
1051
+ string;
803
1052
  /** The unique ID of the customer to retrieve data for. */
804
- customerId?: string;
1053
+ customerId?:
1054
+ string;
805
1055
  /** Represents the date the usage occurred, based on PST time zone. The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`. */
806
- date: string;
1056
+ date:
1057
+ string;
807
1058
  /** Selector specifying which fields to include in a partial response. */
808
- fields?: string;
1059
+ fields?:
1060
+ string;
809
1061
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
810
- key?: string;
1062
+ key?:
1063
+ string;
811
1064
  /** OAuth 2.0 token for the current user. */
812
- oauth_token?: string;
1065
+ oauth_token?:
1066
+ string;
813
1067
  /**
814
1068
  * Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests getting all of the report's pages, enter the
815
1069
  * `nextPageToken` value in the `pageToken` query string.
816
1070
  */
817
- pageToken?: string;
1071
+ pageToken?:
1072
+ string;
818
1073
  /**
819
1074
  * The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The
820
1075
  * application values for the Customers usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`,
@@ -823,15 +1078,20 @@ declare namespace gapi.client {
823
1078
  * addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid
824
1079
  * request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned.
825
1080
  */
826
- parameters?: string;
1081
+ parameters?:
1082
+ string;
827
1083
  /** Returns response with indentations and line breaks. */
828
- prettyPrint?: boolean;
1084
+ prettyPrint?:
1085
+ boolean;
829
1086
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
830
- quotaUser?: string;
1087
+ quotaUser?:
1088
+ string;
831
1089
  /** Upload protocol for media (e.g. "raw", "multipart"). */
832
- upload_protocol?: string;
1090
+ upload_protocol?:
1091
+ string;
833
1092
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
834
- uploadType?: string;
1093
+ uploadType?:
1094
+ string;
835
1095
  }): Request<UsageReports>;
836
1096
  }
837
1097
  interface EntityUsageReportsResource {
@@ -841,26 +1101,35 @@ declare namespace gapi.client {
841
1101
  */
842
1102
  get(request?: {
843
1103
  /** V1 error format. */
844
- "$.xgafv"?: string;
1104
+ "$.xgafv"?:
1105
+ string;
845
1106
  /** OAuth access token. */
846
- access_token?: string;
1107
+ access_token?:
1108
+ string;
847
1109
  /** Data format for response. */
848
- alt?: string;
1110
+ alt?:
1111
+ string;
849
1112
  /** JSONP */
850
- callback?: string;
1113
+ callback?:
1114
+ string;
851
1115
  /** The unique ID of the customer to retrieve data for. */
852
- customerId?: string;
1116
+ customerId?:
1117
+ string;
853
1118
  /** Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. */
854
- date: string;
1119
+ date:
1120
+ string;
855
1121
  /**
856
1122
  * Represents the key of the object to filter the data with. It is a string which can take the value `all` to get activity events for all users, or any other value for an
857
1123
  * app-specific entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides.
858
1124
  */
859
- entityKey: string;
1125
+ entityKey:
1126
+ string;
860
1127
  /** Represents the type of entity for the report. */
861
- entityType: string;
1128
+ entityType:
1129
+ string;
862
1130
  /** Selector specifying which fields to include in a partial response. */
863
- fields?: string;
1131
+ fields?:
1132
+ string;
864
1133
  /**
865
1134
  * The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters`
866
1135
  * query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include `accounts`, `docs`, and
@@ -870,21 +1139,26 @@ declare namespace gapi.client {
870
1139
  * URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is
871
1140
  * URL-encoded (%3E=). Filters can only be applied to numeric parameters.
872
1141
  */
873
- filters?: string;
1142
+ filters?:
1143
+ string;
874
1144
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
875
- key?: string;
1145
+ key?:
1146
+ string;
876
1147
  /**
877
1148
  * Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two
878
1149
  * pages. The response's `nextPageToken` property has the token to the second page.
879
1150
  */
880
- maxResults?: number;
1151
+ maxResults?:
1152
+ number;
881
1153
  /** OAuth 2.0 token for the current user. */
882
- oauth_token?: string;
1154
+ oauth_token?:
1155
+ string;
883
1156
  /**
884
1157
  * Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the
885
1158
  * `nextPageToken` value in the `pageToken` query string.
886
1159
  */
887
- pageToken?: string;
1160
+ pageToken?:
1161
+ string;
888
1162
  /**
889
1163
  * The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The
890
1164
  * application values for the Entities usage report are only `gplus`. A `parameter` query string is in the CSV form of `[app_name1:param_name1], [app_name2:param_name2]...`.
@@ -893,15 +1167,20 @@ declare namespace gapi.client {
893
1167
  * corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are
894
1168
  * requested, all parameters are returned.
895
1169
  */
896
- parameters?: string;
1170
+ parameters?:
1171
+ string;
897
1172
  /** Returns response with indentations and line breaks. */
898
- prettyPrint?: boolean;
1173
+ prettyPrint?:
1174
+ boolean;
899
1175
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
900
- quotaUser?: string;
1176
+ quotaUser?:
1177
+ string;
901
1178
  /** Upload protocol for media (e.g. "raw", "multipart"). */
902
- upload_protocol?: string;
1179
+ upload_protocol?:
1180
+ string;
903
1181
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
904
- uploadType?: string;
1182
+ uploadType?:
1183
+ string;
905
1184
  }): Request<UsageReports>;
906
1185
  }
907
1186
  interface UserUsageReportResource {
@@ -911,22 +1190,29 @@ declare namespace gapi.client {
911
1190
  */
912
1191
  get(request?: {
913
1192
  /** V1 error format. */
914
- "$.xgafv"?: string;
1193
+ "$.xgafv"?:
1194
+ string;
915
1195
  /** OAuth access token. */
916
- access_token?: string;
1196
+ access_token?:
1197
+ string;
917
1198
  /** Data format for response. */
918
- alt?: string;
1199
+ alt?:
1200
+ string;
919
1201
  /** JSONP */
920
- callback?: string;
1202
+ callback?:
1203
+ string;
921
1204
  /** The unique ID of the customer to retrieve data for. */
922
- customerId?: string;
1205
+ customerId?:
1206
+ string;
923
1207
  /**
924
1208
  * Represents the date the usage occurred, based on GMT-7:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601),
925
1209
  * `yyyy-mm-dd`.
926
1210
  */
927
- date: string;
1211
+ date:
1212
+ string;
928
1213
  /** Selector specifying which fields to include in a partial response. */
929
- fields?: string;
1214
+ fields?:
1215
+ string;
930
1216
  /**
931
1217
  * The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters`
932
1218
  * query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include `accounts`, `docs`, and
@@ -936,31 +1222,38 @@ declare namespace gapi.client {
936
1222
  * - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or
937
1223
  * equal to'. It is URL-encoded (%3E=).
938
1224
  */
939
- filters?: string;
1225
+ filters?:
1226
+ string;
940
1227
  /**
941
1228
  * Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of
942
1229
  * the group ids mentioned here. Format: "id:abc123,id:xyz456"
943
1230
  */
944
- groupIdFilter?: string;
1231
+ groupIdFilter?:
1232
+ string;
945
1233
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
946
- key?: string;
1234
+ key?:
1235
+ string;
947
1236
  /**
948
1237
  * Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two
949
1238
  * pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional.
950
1239
  */
951
- maxResults?: number;
1240
+ maxResults?:
1241
+ number;
952
1242
  /** OAuth 2.0 token for the current user. */
953
- oauth_token?: string;
1243
+ oauth_token?:
1244
+ string;
954
1245
  /**
955
1246
  * ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear
956
1247
  * in the filtered results.
957
1248
  */
958
- orgUnitID?: string;
1249
+ orgUnitID?:
1250
+ string;
959
1251
  /**
960
1252
  * Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the
961
1253
  * `nextPageToken` value in the `pageToken` query string.
962
1254
  */
963
- pageToken?: string;
1255
+ pageToken?:
1256
+ string;
964
1257
  /**
965
1258
  * The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The
966
1259
  * application values for the Customers Usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`,
@@ -969,21 +1262,27 @@ declare namespace gapi.client {
969
1262
  * addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid
970
1263
  * request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned.
971
1264
  */
972
- parameters?: string;
1265
+ parameters?:
1266
+ string;
973
1267
  /** Returns response with indentations and line breaks. */
974
- prettyPrint?: boolean;
1268
+ prettyPrint?:
1269
+ boolean;
975
1270
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
976
- quotaUser?: string;
1271
+ quotaUser?:
1272
+ string;
977
1273
  /** Upload protocol for media (e.g. "raw", "multipart"). */
978
- upload_protocol?: string;
1274
+ upload_protocol?:
1275
+ string;
979
1276
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
980
- uploadType?: string;
1277
+ uploadType?:
1278
+ string;
981
1279
  /**
982
1280
  * Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID
983
1281
  * or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the
984
1282
  * `userKey`.
985
1283
  */
986
- userKey: string;
1284
+ userKey:
1285
+ string;
987
1286
  }): Request<UsageReports>;
988
1287
  }
989
1288