v1.d.ts
26.3 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
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace homegraph_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* 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
* const {google} = require('googleapis');
* const homegraph = google.homegraph('v1');
*
* @namespace homegraph
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Homegraph
*/
export class Homegraph {
context: APIRequestContext;
agentUsers: Resource$Agentusers;
devices: Resource$Devices;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Third-party partner's device ID for one device.
*/
export interface Schema$AgentDeviceId {
/**
* Third-party partner's device ID.
*/
id?: string | null;
}
/**
* Identifies a device in the third party or first party system.
*/
export interface Schema$AgentOtherDeviceId {
/**
* The agent's ID. Generally it is the agent's AoG project id.
*/
agentId?: string | null;
/**
* Device ID defined by the agent. The device_id must be unique.
*/
deviceId?: string | null;
}
/**
* Third-party partner's device definition.
*/
export interface Schema$Device {
/**
* Attributes for the traits supported by the device.
*/
attributes?: {
[key: string]: any;
} | null;
/**
* Custom JSON data provided by the manufacturer and attached to QUERY and EXECUTE requests in AoG.
*/
customData?: string | null;
/**
* Device manufacturer, model, hardware version, and software version.
*/
deviceInfo?: Schema$DeviceInfo;
/**
* Third-party partner's device ID.
*/
id?: string | null;
/**
* Name of the device given by the third party. This includes names given to the device via third party device manufacturer's app, model names for the device, etc.
*/
name?: Schema$DeviceNames;
/**
* IDs of other devices associated with this device. This is used to represent a device group (e.g. bonded zone) or "facets" synced through different flows (e.g. Google Nest Hub Max with a Nest Camera). This may also be used to pass in alternate IDs used to identify a cloud synced device for local execution (i.e. local verification). If used for local verification, this field is synced from the cloud.
*/
otherDeviceIds?: Schema$AgentOtherDeviceId[];
/**
* If the third-party partner's cloud configuration includes placing devices in rooms, the name of the room can be provided here.
*/
roomHint?: string | null;
/**
* As in roomHint, for structures that users set up in the partner's system.
*/
structureHint?: string | null;
/**
* Traits supported by the device.
*/
traits?: string[] | null;
/**
* Hardware type of the device (e.g. light, outlet, etc).
*/
type?: string | null;
/**
* Indicates whether the state of this device is being reported to Google through ReportStateAndNotification call.
*/
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;
}
/**
* Different names for the device.
*/
export interface Schema$DeviceNames {
/**
* List of names provided by the partner rather than the user, often manufacturer names, 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. This should be the same format as the Actions on Google `action.devices.QUERY` [request](/actions/smarthome/create-app#actiondevicesquery) with the exception of the extra `agent_user_id` and no `intent` and `customData` fields.
*/
export interface Schema$QueryRequest {
/**
* Required. Third-party user ID.
*/
agentUserId?: string | null;
/**
* Required. Inputs containing third-party partner's 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 partner's device IDs.
*/
payload?: Schema$QueryRequestPayload;
}
/**
* Payload containing device IDs.
*/
export interface Schema$QueryRequestPayload {
/**
* Third-party partner's 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 Actions on Google `action.devices.QUERY` [response](/actions/smarthome/create-app#actiondevicesquery). # 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.
*/
notifications?: {
[key: string]: any;
} | null;
/**
* States of devices to update.
*/
states?: {
[key: string]: any;
} | null;
}
/**
* Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. It may include States, Notifications, or both. This request uses globally unique flattened state names instead of namespaces based on traits to align with the existing QUERY and EXECUTE APIs implemented by 90+ Smart Home partners. 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;
/**
* Token to maintain state in the follow up notification response.
*/
followUpToken?: string | null;
/**
* State of devices to update and notification metadata for devices. For example, if a user turns a light on manually, a state update should be sent so that the information is always the current status of the device. Notifications are independent from the state and its piece of the payload should contain everything necessary to notify the user. Although it may be related to a state change, it does not need to be. For example, if a device can turn on/off and change temperature, the states reported would include both "on" and "70 degrees" but the 3p may choose not to send any notification for that, or to only say that the "the room is heating up", keeping state and notification independent.
*/
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 issued by agent's third-party identity provider.
*/
agentUserId?: string | null;
/**
* Optional. If set, the request will be added to a queue and a response will be returned immediately. The queue allows for de-duplication of simultaneous requests.
*/
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. This should follow the same format as the Actions on Google `action.devices.SYNC` [request](/actions/smarthome/create-app#actiondevicessync) with the exception of the extra `agent_user_id` and no `intent` field.
*/
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 Actions on Google `action.devices.SYNC` [response](/actions/smarthome/create-app#actiondevicessync). # 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);
/**
* homegraph.agentUsers.delete
* @desc Unlinks an agent user from Google. As a result, all data related to this user will be deleted. Here is how the agent user is created in Google: 1. When a user opens their Google Home App, they can begin linking a 3p partner. 2. User is guided through the OAuth process. 3. After entering the 3p credentials, Google gets the 3p OAuth token and uses it to make a Sync call to the 3p partner and gets back all of the user's data, including `agent_user_id` and devices. 4. Google creates the agent user and stores a mapping from the `agent_user_id` -> Google ID mapping. Google also stores all of the user's devices under that Google ID. The mapping from `agent_user_id` to Google ID is many to many, since one Google user can have multiple 3p accounts, and multiple Google users can map to one `agent_user_id` (e.g., a husband and wife share one Nest account username/password). The third-party user's identity is passed in as `agent_user_id`. The agent is identified by the JWT signed by the partner's service account. Note: Special characters (except "/") in `agent_user_id` must be URL-encoded.
* @alias homegraph.agentUsers.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.agentUserId Required. Third-party user ID.
* @param {string=} params.requestId Request ID used for debugging.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Agentusers$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
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 {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Third-party user ID.
*/
agentUserId?: string;
/**
* Request ID used for debugging.
*/
requestId?: string;
}
export class Resource$Devices {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* homegraph.devices.query
* @desc Gets the device states for the devices in QueryRequest. The third-party user's identity is passed in as `agent_user_id`. The agent is identified by the JWT signed by the third-party partner's service account.
* @alias homegraph.devices.query
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().QueryRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
query(params?: Params$Resource$Devices$Query, options?: MethodOptions): GaxiosPromise<Schema$QueryResponse>;
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;
/**
* homegraph.devices.reportStateAndNotification
* @desc Reports device state and optionally sends device notifications. Called by an agent when the device state of a third-party changes or the agent wants to send a notification about the device. See [Implement Report State](/actions/smarthome/report-state) for more information. This method updates a predefined set of states for a device, which all devices have according to their prescribed traits (for example, a light will have the [OnOff](/actions/smarthome/traits/onoff) trait that reports the state `on` as a boolean value). A new state may not be created and an INVALID_ARGUMENT code will be thrown if so. It also optionally takes in a list of Notifications that may be created, which are associated to this state change. The third-party user's identity is passed in as `agent_user_id`. The agent is identified by the JWT signed by the partner's service account.
* @alias homegraph.devices.reportStateAndNotification
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().ReportStateAndNotificationRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
reportStateAndNotification(params?: Params$Resource$Devices$Reportstateandnotification, options?: MethodOptions): GaxiosPromise<Schema$ReportStateAndNotificationResponse>;
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;
/**
* homegraph.devices.requestSync
* @desc Requests a `SYNC` call from Google to a 3p partner's home control agent for a user. The third-party user's identity is passed in as `agent_user_id` (see RequestSyncDevicesRequest) and forwarded back to the agent. The agent is identified by the API key or JWT signed by the partner's service account.
* @alias homegraph.devices.requestSync
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().RequestSyncDevicesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
requestSync(params?: Params$Resource$Devices$Requestsync, options?: MethodOptions): GaxiosPromise<Schema$RequestSyncDevicesResponse>;
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;
/**
* homegraph.devices.sync
* @desc Gets all the devices associated with the given third-party user. The third-party user's identity is passed in as `agent_user_id`. The agent is identified by the JWT signed by the third-party partner's service account.
* @alias homegraph.devices.sync
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().SyncRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
sync(params?: Params$Resource$Devices$Sync, options?: MethodOptions): GaxiosPromise<Schema$SyncResponse>;
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 {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$QueryRequest;
}
export interface Params$Resource$Devices$Reportstateandnotification extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$ReportStateAndNotificationRequest;
}
export interface Params$Resource$Devices$Requestsync extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$RequestSyncDevicesRequest;
}
export interface Params$Resource$Devices$Sync extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$SyncRequest;
}
export {};
}