v1.d.ts
31.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace homegraph_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* HomeGraph API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const homegraph = google.homegraph('v1');
* ```
*/
export class Homegraph {
context: APIRequestContext;
agentUsers: Resource$Agentusers;
devices: Resource$Devices;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Third-party device ID for one device.
*/
export interface Schema$AgentDeviceId {
/**
* Third-party device ID.
*/
id?: string | null;
}
/**
* Alternate third-party device ID.
*/
export interface Schema$AgentOtherDeviceId {
/**
* Project ID for your smart home Action.
*/
agentId?: string | null;
/**
* Unique third-party device ID.
*/
deviceId?: string | null;
}
/**
* Third-party device definition. Next ID = 14
*/
export interface Schema$Device {
/**
* Attributes for the traits supported by the device.
*/
attributes?: {
[key: string]: any;
} | null;
/**
* Custom device attributes stored in Home Graph and provided to your smart home Action in each [QUERY](https://developers.google.com/assistant/smarthome/reference/intent/query) and [EXECUTE](https://developers.google.com/assistant/smarthome/reference/intent/execute) intent. Data in this object has a few constraints: No sensitive information, including but not limited to Personally Identifiable Information.
*/
customData?: {
[key: string]: any;
} | null;
/**
* Device manufacturer, model, hardware version, and software version.
*/
deviceInfo?: Schema$DeviceInfo;
/**
* Third-party device ID.
*/
id?: string | null;
/**
* Names given to this device by your smart home Action.
*/
name?: Schema$DeviceNames;
/**
* Indicates whether your smart home Action will report notifications to Google for this device via ReportStateAndNotification. If your smart home Action enables users to control device notifications, you should update this field and call RequestSyncDevices.
*/
notificationSupportedByAgent?: boolean | null;
/**
* Alternate IDs associated with this device. This is used to identify cloud synced devices enabled for [local fulfillment](https://developers.google.com/assistant/smarthome/concepts/local).
*/
otherDeviceIds?: Schema$AgentOtherDeviceId[];
/**
* Suggested name for the room where this device is installed. Google attempts to use this value during user setup.
*/
roomHint?: string | null;
/**
* Suggested name for the structure where this device is installed. Google attempts to use this value during user setup.
*/
structureHint?: string | null;
/**
* Traits supported by the device. See [device traits](https://developers.google.com/assistant/smarthome/traits).
*/
traits?: string[] | null;
/**
* Hardware type of the device. See [device types](https://developers.google.com/assistant/smarthome/guides).
*/
type?: string | null;
/**
* Indicates whether your smart home Action will report state of this device to Google via ReportStateAndNotification.
*/
willReportState?: boolean | null;
}
/**
* Device information.
*/
export interface Schema$DeviceInfo {
/**
* Device hardware version.
*/
hwVersion?: string | null;
/**
* Device manufacturer.
*/
manufacturer?: string | null;
/**
* Device model.
*/
model?: string | null;
/**
* Device software version.
*/
swVersion?: string | null;
}
/**
* Identifiers used to describe the device.
*/
export interface Schema$DeviceNames {
/**
* List of names provided by the manufacturer rather than the user, such as serial numbers, SKUs, etc.
*/
defaultNames?: string[] | null;
/**
* Primary name of the device, generally provided by the user.
*/
name?: string | null;
/**
* Additional names provided by the user for the device.
*/
nicknames?: string[] | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$Empty {
}
/**
* Request type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call.
*/
export interface Schema$QueryRequest {
/**
* Required. Third-party user ID.
*/
agentUserId?: string | null;
/**
* Required. Inputs containing third-party device IDs for which to get the device states.
*/
inputs?: Schema$QueryRequestInput[];
/**
* Request ID used for debugging.
*/
requestId?: string | null;
}
/**
* Device ID inputs to QueryRequest.
*/
export interface Schema$QueryRequestInput {
/**
* Payload containing third-party device IDs.
*/
payload?: Schema$QueryRequestPayload;
}
/**
* Payload containing device IDs.
*/
export interface Schema$QueryRequestPayload {
/**
* Third-party device IDs for which to get the device states.
*/
devices?: Schema$AgentDeviceId[];
}
/**
* Response type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. This should follow the same format as the Google smart home `action.devices.QUERY` [response](https://developers.google.com/assistant/smarthome/reference/intent/query). # Example ```json { "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "devices": { "123": { "on": true, "online": true \}, "456": { "on": true, "online": true, "brightness": 80, "color": { "name": "cerulean", "spectrumRGB": 31655 \} \} \} \} \} ```
*/
export interface Schema$QueryResponse {
/**
* Device states for the devices given in the request.
*/
payload?: Schema$QueryResponsePayload;
/**
* Request ID used for debugging. Copied from the request.
*/
requestId?: string | null;
}
/**
* Payload containing device states information.
*/
export interface Schema$QueryResponsePayload {
/**
* States of the devices. Map of third-party device ID to struct of device states.
*/
devices?: {
[key: string]: {
[key: string]: any;
};
} | null;
}
/**
* The states and notifications specific to a device.
*/
export interface Schema$ReportStateAndNotificationDevice {
/**
* Notifications metadata for devices. See the **Device NOTIFICATIONS** section of the individual trait [reference guides](https://developers.google.com/assistant/smarthome/traits).
*/
notifications?: {
[key: string]: any;
} | null;
/**
* States of devices to update. See the **Device STATES** section of the individual trait [reference guides](https://developers.google.com/assistant/smarthome/traits).
*/
states?: {
[key: string]: any;
} | null;
}
/**
* Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. It may include states, notifications, or both. States and notifications are defined per `device_id` (for example, "123" and "456" in the following example). # Example ```json { "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "agentUserId": "1234", "payload": { "devices": { "states": { "123": { "on": true \}, "456": { "on": true, "brightness": 10 \} \}, \} \} \} ```
*/
export interface Schema$ReportStateAndNotificationRequest {
/**
* Required. Third-party user ID.
*/
agentUserId?: string | null;
/**
* Unique identifier per event (for example, a doorbell press).
*/
eventId?: string | null;
/**
* Deprecated.
*/
followUpToken?: string | null;
/**
* Required. State of devices to update and notification metadata for devices.
*/
payload?: Schema$StateAndNotificationPayload;
/**
* Request ID used for debugging.
*/
requestId?: string | null;
}
/**
* Response type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call.
*/
export interface Schema$ReportStateAndNotificationResponse {
/**
* Request ID copied from ReportStateAndNotificationRequest.
*/
requestId?: string | null;
}
/**
* Request type for the [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) call.
*/
export interface Schema$RequestSyncDevicesRequest {
/**
* Required. Third-party user ID.
*/
agentUserId?: string | null;
/**
* Optional. If set, the request will be added to a queue and a response will be returned immediately. This enables concurrent requests for the given `agent_user_id`, but the caller will not receive any error responses.
*/
async?: boolean | null;
}
/**
* Response type for the [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) call. Intentionally empty upon success. An HTTP response code is returned with more details upon failure.
*/
export interface Schema$RequestSyncDevicesResponse {
}
/**
* Payload containing the state and notification information for devices.
*/
export interface Schema$StateAndNotificationPayload {
/**
* The devices for updating state and sending notifications.
*/
devices?: Schema$ReportStateAndNotificationDevice;
}
/**
* Request type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call.
*/
export interface Schema$SyncRequest {
/**
* Required. Third-party user ID.
*/
agentUserId?: string | null;
/**
* Request ID used for debugging.
*/
requestId?: string | null;
}
/**
* Response type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call. This should follow the same format as the Google smart home `action.devices.SYNC` [response](https://developers.google.com/assistant/smarthome/reference/intent/sync). # Example ```json { "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "agentUserId": "1836.15267389", "devices": [{ "id": "123", "type": "action.devices.types.OUTLET", "traits": [ "action.devices.traits.OnOff" ], "name": { "defaultNames": ["My Outlet 1234"], "name": "Night light", "nicknames": ["wall plug"] \}, "willReportState": false, "deviceInfo": { "manufacturer": "lights-out-inc", "model": "hs1234", "hwVersion": "3.2", "swVersion": "11.4" \}, "customData": { "fooValue": 74, "barValue": true, "bazValue": "foo" \} \}] \} \} ```
*/
export interface Schema$SyncResponse {
/**
* Devices associated with the third-party user.
*/
payload?: Schema$SyncResponsePayload;
/**
* Request ID used for debugging. Copied from the request.
*/
requestId?: string | null;
}
/**
* Payload containing device information.
*/
export interface Schema$SyncResponsePayload {
/**
* Third-party user ID
*/
agentUserId?: string | null;
/**
* Devices associated with the third-party user.
*/
devices?: Schema$Device[];
}
export class Resource$Agentusers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Unlinks the given third-party user from your smart home Action. All data related to this user will be deleted. For more details on how users link their accounts, see [fulfillment and authentication](https://developers.google.com/assistant/smarthome/concepts/fulfillment-authentication). The third-party user's identity is passed in via the `agent_user_id` (see DeleteAgentUserRequest). This request must be authorized using service account credentials from your Actions console project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/homegraph.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const homegraph = google.homegraph('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/homegraph'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await homegraph.agentUsers.delete({
* // Required. Third-party user ID.
* agentUserId: 'agentUsers/.*',
* // Request ID used for debugging.
* requestId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Agentusers$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Agentusers$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Agentusers$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Agentusers$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Agentusers$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
}
export interface Params$Resource$Agentusers$Delete extends StandardParameters {
/**
* Required. Third-party user ID.
*/
agentUserId?: string;
/**
* Request ID used for debugging.
*/
requestId?: string;
}
export class Resource$Devices {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Gets the current states in Home Graph for the given set of the third-party user's devices. The third-party user's identity is passed in via the `agent_user_id` (see QueryRequest). This request must be authorized using service account credentials from your Actions console project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/homegraph.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const homegraph = google.homegraph('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/homegraph'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await homegraph.devices.query({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "agentUserId": "my_agentUserId",
* // "inputs": [],
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "payload": {},
* // "requestId": "my_requestId"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
query(params: Params$Resource$Devices$Query, options: StreamMethodOptions): GaxiosPromise<Readable>;
query(params?: Params$Resource$Devices$Query, options?: MethodOptions): GaxiosPromise<Schema$QueryResponse>;
query(params: Params$Resource$Devices$Query, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
query(params: Params$Resource$Devices$Query, options: MethodOptions | BodyResponseCallback<Schema$QueryResponse>, callback: BodyResponseCallback<Schema$QueryResponse>): void;
query(params: Params$Resource$Devices$Query, callback: BodyResponseCallback<Schema$QueryResponse>): void;
query(callback: BodyResponseCallback<Schema$QueryResponse>): void;
/**
* Reports device state and optionally sends device notifications. Called by your smart home Action when the state of a third-party device changes or you need to send a notification about the device. See [Implement Report State](https://developers.google.com/assistant/smarthome/develop/report-state) for more information. This method updates the device state according to its declared [traits](https://developers.google.com/assistant/smarthome/concepts/devices-traits). Publishing a new state value outside of these traits will result in an `INVALID_ARGUMENT` error response. The third-party user's identity is passed in via the `agent_user_id` (see ReportStateAndNotificationRequest). This request must be authorized using service account credentials from your Actions console project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/homegraph.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const homegraph = google.homegraph('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/homegraph'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await homegraph.devices.reportStateAndNotification({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "agentUserId": "my_agentUserId",
* // "eventId": "my_eventId",
* // "followUpToken": "my_followUpToken",
* // "payload": {},
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "requestId": "my_requestId"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
reportStateAndNotification(params: Params$Resource$Devices$Reportstateandnotification, options: StreamMethodOptions): GaxiosPromise<Readable>;
reportStateAndNotification(params?: Params$Resource$Devices$Reportstateandnotification, options?: MethodOptions): GaxiosPromise<Schema$ReportStateAndNotificationResponse>;
reportStateAndNotification(params: Params$Resource$Devices$Reportstateandnotification, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
reportStateAndNotification(params: Params$Resource$Devices$Reportstateandnotification, options: MethodOptions | BodyResponseCallback<Schema$ReportStateAndNotificationResponse>, callback: BodyResponseCallback<Schema$ReportStateAndNotificationResponse>): void;
reportStateAndNotification(params: Params$Resource$Devices$Reportstateandnotification, callback: BodyResponseCallback<Schema$ReportStateAndNotificationResponse>): void;
reportStateAndNotification(callback: BodyResponseCallback<Schema$ReportStateAndNotificationResponse>): void;
/**
* Requests Google to send an `action.devices.SYNC` [intent](https://developers.google.com/assistant/smarthome/reference/intent/sync) to your smart home Action to update device metadata for the given user. The third-party user's identity is passed via the `agent_user_id` (see RequestSyncDevicesRequest). This request must be authorized using service account credentials from your Actions console project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/homegraph.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const homegraph = google.homegraph('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/homegraph'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await homegraph.devices.requestSync({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "agentUserId": "my_agentUserId",
* // "async": false
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
requestSync(params: Params$Resource$Devices$Requestsync, options: StreamMethodOptions): GaxiosPromise<Readable>;
requestSync(params?: Params$Resource$Devices$Requestsync, options?: MethodOptions): GaxiosPromise<Schema$RequestSyncDevicesResponse>;
requestSync(params: Params$Resource$Devices$Requestsync, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
requestSync(params: Params$Resource$Devices$Requestsync, options: MethodOptions | BodyResponseCallback<Schema$RequestSyncDevicesResponse>, callback: BodyResponseCallback<Schema$RequestSyncDevicesResponse>): void;
requestSync(params: Params$Resource$Devices$Requestsync, callback: BodyResponseCallback<Schema$RequestSyncDevicesResponse>): void;
requestSync(callback: BodyResponseCallback<Schema$RequestSyncDevicesResponse>): void;
/**
* Gets all the devices associated with the given third-party user. The third-party user's identity is passed in via the `agent_user_id` (see SyncRequest). This request must be authorized using service account credentials from your Actions console project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/homegraph.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const homegraph = google.homegraph('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/homegraph'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await homegraph.devices.sync({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "agentUserId": "my_agentUserId",
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "payload": {},
* // "requestId": "my_requestId"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
sync(params: Params$Resource$Devices$Sync, options: StreamMethodOptions): GaxiosPromise<Readable>;
sync(params?: Params$Resource$Devices$Sync, options?: MethodOptions): GaxiosPromise<Schema$SyncResponse>;
sync(params: Params$Resource$Devices$Sync, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
sync(params: Params$Resource$Devices$Sync, options: MethodOptions | BodyResponseCallback<Schema$SyncResponse>, callback: BodyResponseCallback<Schema$SyncResponse>): void;
sync(params: Params$Resource$Devices$Sync, callback: BodyResponseCallback<Schema$SyncResponse>): void;
sync(callback: BodyResponseCallback<Schema$SyncResponse>): void;
}
export interface Params$Resource$Devices$Query extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$QueryRequest;
}
export interface Params$Resource$Devices$Reportstateandnotification extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$ReportStateAndNotificationRequest;
}
export interface Params$Resource$Devices$Requestsync extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$RequestSyncDevicesRequest;
}
export interface Params$Resource$Devices$Sync extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$SyncRequest;
}
export {};
}