v1.d.ts
33 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
727
728
/// <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 smartdevicemanagement_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;
}
/**
* Smart Device Management API
*
* Allow select enterprise partners to access, control, and manage Google and Nest devices programmatically.
*
* @example
* ```js
* const {google} = require('googleapis');
* const smartdevicemanagement = google.smartdevicemanagement('v1');
* ```
*/
export class Smartdevicemanagement {
context: APIRequestContext;
enterprises: Resource$Enterprises;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Device resource represents an instance of enterprise managed device in the property.
*/
export interface Schema$GoogleHomeEnterpriseSdmV1Device {
/**
* Required. The resource name of the device. For example: "enterprises/XYZ/devices/123".
*/
name?: string | null;
/**
* Assignee details of the device.
*/
parentRelations?: Schema$GoogleHomeEnterpriseSdmV1ParentRelation[];
/**
* Output only. Device traits.
*/
traits?: {
[key: string]: any;
} | null;
/**
* Output only. Type of the device for general display purposes. For example: "THERMOSTAT". The device type should not be used to deduce or infer functionality of the actual device it is assigned to. Instead, use the returned traits for the device.
*/
type?: string | null;
}
/**
* Request message for SmartDeviceManagementService.ExecuteDeviceCommand
*/
export interface Schema$GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest {
/**
* The command name to execute, represented by the fully qualified protobuf message name.
*/
command?: string | null;
/**
* The command message to execute, represented as a Struct.
*/
params?: {
[key: string]: any;
} | null;
}
/**
* Response message for SmartDeviceManagementService.ExecuteDeviceCommand
*/
export interface Schema$GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse {
/**
* The results of executing the command.
*/
results?: {
[key: string]: any;
} | null;
}
/**
* Response message for SmartDeviceManagementService.ListDevices
*/
export interface Schema$GoogleHomeEnterpriseSdmV1ListDevicesResponse {
/**
* The list of devices.
*/
devices?: Schema$GoogleHomeEnterpriseSdmV1Device[];
/**
* The pagination token to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for SmartDeviceManagementService.ListRooms
*/
export interface Schema$GoogleHomeEnterpriseSdmV1ListRoomsResponse {
/**
* The pagination token to retrieve the next page of results. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The list of rooms.
*/
rooms?: Schema$GoogleHomeEnterpriseSdmV1Room[];
}
/**
* Response message for SmartDeviceManagementService.ListStructures
*/
export interface Schema$GoogleHomeEnterpriseSdmV1ListStructuresResponse {
/**
* The pagination token to retrieve the next page of results. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The list of structures.
*/
structures?: Schema$GoogleHomeEnterpriseSdmV1Structure[];
}
/**
* Represents device relationships, for instance, structure/room to which the device is assigned to.
*/
export interface Schema$GoogleHomeEnterpriseSdmV1ParentRelation {
/**
* Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to.
*/
displayName?: string | null;
/**
* Output only. The name of the relation -- e.g., structure/room where the device is assigned to. For example: "enterprises/XYZ/structures/ABC" or "enterprises/XYZ/structures/ABC/rooms/123"
*/
parent?: string | null;
}
/**
* Room resource represents an instance of sub-space within a structure such as rooms in a hotel suite or rental apartment.
*/
export interface Schema$GoogleHomeEnterpriseSdmV1Room {
/**
* Output only. The resource name of the room. For example: "enterprises/XYZ/structures/ABC/rooms/123".
*/
name?: string | null;
/**
* Room traits.
*/
traits?: {
[key: string]: any;
} | null;
}
/**
* Structure resource represents an instance of enterprise managed home or hotel room.
*/
export interface Schema$GoogleHomeEnterpriseSdmV1Structure {
/**
* Output only. The resource name of the structure. For example: "enterprises/XYZ/structures/ABC".
*/
name?: string | null;
/**
* Structure traits.
*/
traits?: {
[key: string]: any;
} | null;
}
export class Resource$Enterprises {
context: APIRequestContext;
devices: Resource$Enterprises$Devices;
structures: Resource$Enterprises$Structures;
constructor(context: APIRequestContext);
}
export class Resource$Enterprises$Devices {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Executes a command to device managed by the enterprise.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/smartdevicemanagement.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 smartdevicemanagement = google.smartdevicemanagement('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/sdm.service'],
* });
*
* // 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 smartdevicemanagement.enterprises.devices.executeCommand({
* // The name of the device requested. For example: "enterprises/XYZ/devices/123"
* name: 'enterprises/my-enterprise/devices/my-device',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "command": "my_command",
* // "params": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "results": {}
* // }
* }
*
* 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.
*/
executeCommand(params: Params$Resource$Enterprises$Devices$Executecommand, options: StreamMethodOptions): GaxiosPromise<Readable>;
executeCommand(params?: Params$Resource$Enterprises$Devices$Executecommand, options?: MethodOptions): GaxiosPromise<Schema$GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse>;
executeCommand(params: Params$Resource$Enterprises$Devices$Executecommand, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
executeCommand(params: Params$Resource$Enterprises$Devices$Executecommand, options: MethodOptions | BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse>, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse>): void;
executeCommand(params: Params$Resource$Enterprises$Devices$Executecommand, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse>): void;
executeCommand(callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse>): void;
/**
* Gets a device managed by the enterprise.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/smartdevicemanagement.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 smartdevicemanagement = google.smartdevicemanagement('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/sdm.service'],
* });
*
* // 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 smartdevicemanagement.enterprises.devices.get({
* // The name of the device requested. For example: "enterprises/XYZ/devices/123"
* name: 'enterprises/my-enterprise/devices/my-device',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "name": "my_name",
* // "parentRelations": [],
* // "traits": {},
* // "type": "my_type"
* // }
* }
*
* 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.
*/
get(params: Params$Resource$Enterprises$Devices$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Enterprises$Devices$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleHomeEnterpriseSdmV1Device>;
get(params: Params$Resource$Enterprises$Devices$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Enterprises$Devices$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Device>, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Device>): void;
get(params: Params$Resource$Enterprises$Devices$Get, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Device>): void;
get(callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Device>): void;
/**
* Lists devices managed by the enterprise.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/smartdevicemanagement.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 smartdevicemanagement = google.smartdevicemanagement('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/sdm.service'],
* });
*
* // 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 smartdevicemanagement.enterprises.devices.list({
* // Optional filter to list devices. Filters can be done on: Device custom name (substring match): 'customName=wing'
* filter: 'placeholder-value',
* // Optional requested page size. Server may return fewer devices than requested. If unspecified, server will pick an appropriate default.
* pageSize: 'placeholder-value',
* // Optional token of the page to retrieve.
* pageToken: 'placeholder-value',
* // The parent enterprise to list devices under. E.g. "enterprises/XYZ".
* parent: 'enterprises/my-enterprise',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "devices": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* 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.
*/
list(params: Params$Resource$Enterprises$Devices$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Enterprises$Devices$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleHomeEnterpriseSdmV1ListDevicesResponse>;
list(params: Params$Resource$Enterprises$Devices$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Enterprises$Devices$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListDevicesResponse>, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListDevicesResponse>): void;
list(params: Params$Resource$Enterprises$Devices$List, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListDevicesResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListDevicesResponse>): void;
}
export interface Params$Resource$Enterprises$Devices$Executecommand extends StandardParameters {
/**
* The name of the device requested. For example: "enterprises/XYZ/devices/123"
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest;
}
export interface Params$Resource$Enterprises$Devices$Get extends StandardParameters {
/**
* The name of the device requested. For example: "enterprises/XYZ/devices/123"
*/
name?: string;
}
export interface Params$Resource$Enterprises$Devices$List extends StandardParameters {
/**
* Optional filter to list devices. Filters can be done on: Device custom name (substring match): 'customName=wing'
*/
filter?: string;
/**
* Optional requested page size. Server may return fewer devices than requested. If unspecified, server will pick an appropriate default.
*/
pageSize?: number;
/**
* Optional token of the page to retrieve.
*/
pageToken?: string;
/**
* The parent enterprise to list devices under. E.g. "enterprises/XYZ".
*/
parent?: string;
}
export class Resource$Enterprises$Structures {
context: APIRequestContext;
rooms: Resource$Enterprises$Structures$Rooms;
constructor(context: APIRequestContext);
/**
* Gets a structure managed by the enterprise.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/smartdevicemanagement.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 smartdevicemanagement = google.smartdevicemanagement('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/sdm.service'],
* });
*
* // 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 smartdevicemanagement.enterprises.structures.get({
* // The name of the structure requested. For example: "enterprises/XYZ/structures/ABC".
* name: 'enterprises/my-enterprise/structures/my-structure',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "name": "my_name",
* // "traits": {}
* // }
* }
*
* 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.
*/
get(params: Params$Resource$Enterprises$Structures$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Enterprises$Structures$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleHomeEnterpriseSdmV1Structure>;
get(params: Params$Resource$Enterprises$Structures$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Enterprises$Structures$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Structure>, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Structure>): void;
get(params: Params$Resource$Enterprises$Structures$Get, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Structure>): void;
get(callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Structure>): void;
/**
* Lists structures managed by the enterprise.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/smartdevicemanagement.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 smartdevicemanagement = google.smartdevicemanagement('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/sdm.service'],
* });
*
* // 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 smartdevicemanagement.enterprises.structures.list({
* // Optional filter to list structures.
* filter: 'placeholder-value',
* // Requested page size. Server may return fewer structures than requested. If unspecified, server will pick an appropriate default.
* pageSize: 'placeholder-value',
* // The token of the page to retrieve.
* pageToken: 'placeholder-value',
* // The parent enterprise to list structures under. E.g. "enterprises/XYZ".
* parent: 'enterprises/my-enterprise',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "structures": []
* // }
* }
*
* 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.
*/
list(params: Params$Resource$Enterprises$Structures$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Enterprises$Structures$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleHomeEnterpriseSdmV1ListStructuresResponse>;
list(params: Params$Resource$Enterprises$Structures$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Enterprises$Structures$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListStructuresResponse>, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListStructuresResponse>): void;
list(params: Params$Resource$Enterprises$Structures$List, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListStructuresResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListStructuresResponse>): void;
}
export interface Params$Resource$Enterprises$Structures$Get extends StandardParameters {
/**
* The name of the structure requested. For example: "enterprises/XYZ/structures/ABC".
*/
name?: string;
}
export interface Params$Resource$Enterprises$Structures$List extends StandardParameters {
/**
* Optional filter to list structures.
*/
filter?: string;
/**
* Requested page size. Server may return fewer structures than requested. If unspecified, server will pick an appropriate default.
*/
pageSize?: number;
/**
* The token of the page to retrieve.
*/
pageToken?: string;
/**
* The parent enterprise to list structures under. E.g. "enterprises/XYZ".
*/
parent?: string;
}
export class Resource$Enterprises$Structures$Rooms {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Gets a room managed by the enterprise.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/smartdevicemanagement.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 smartdevicemanagement = google.smartdevicemanagement('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/sdm.service'],
* });
*
* // 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 smartdevicemanagement.enterprises.structures.rooms.get({
* // The name of the room requested. For example: "enterprises/XYZ/structures/ABC/rooms/123".
* name: 'enterprises/my-enterprise/structures/my-structure/rooms/my-room',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "name": "my_name",
* // "traits": {}
* // }
* }
*
* 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.
*/
get(params: Params$Resource$Enterprises$Structures$Rooms$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Enterprises$Structures$Rooms$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleHomeEnterpriseSdmV1Room>;
get(params: Params$Resource$Enterprises$Structures$Rooms$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Enterprises$Structures$Rooms$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Room>, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Room>): void;
get(params: Params$Resource$Enterprises$Structures$Rooms$Get, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Room>): void;
get(callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1Room>): void;
/**
* Lists rooms managed by the enterprise.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/smartdevicemanagement.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 smartdevicemanagement = google.smartdevicemanagement('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/sdm.service'],
* });
*
* // 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 smartdevicemanagement.enterprises.structures.rooms.list({
* // Requested page size. Server may return fewer rooms than requested. If unspecified, server will pick an appropriate default.
* pageSize: 'placeholder-value',
* // The token of the page to retrieve.
* pageToken: 'placeholder-value',
* // The parent resource name of the rooms requested. For example: "enterprises/XYZ/structures/ABC".
* parent: 'enterprises/my-enterprise/structures/my-structure',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "rooms": []
* // }
* }
*
* 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.
*/
list(params: Params$Resource$Enterprises$Structures$Rooms$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Enterprises$Structures$Rooms$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleHomeEnterpriseSdmV1ListRoomsResponse>;
list(params: Params$Resource$Enterprises$Structures$Rooms$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Enterprises$Structures$Rooms$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListRoomsResponse>, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListRoomsResponse>): void;
list(params: Params$Resource$Enterprises$Structures$Rooms$List, callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListRoomsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleHomeEnterpriseSdmV1ListRoomsResponse>): void;
}
export interface Params$Resource$Enterprises$Structures$Rooms$Get extends StandardParameters {
/**
* The name of the room requested. For example: "enterprises/XYZ/structures/ABC/rooms/123".
*/
name?: string;
}
export interface Params$Resource$Enterprises$Structures$Rooms$List extends StandardParameters {
/**
* Requested page size. Server may return fewer rooms than requested. If unspecified, server will pick an appropriate default.
*/
pageSize?: number;
/**
* The token of the page to retrieve.
*/
pageToken?: string;
/**
* The parent resource name of the rooms requested. For example: "enterprises/XYZ/structures/ABC".
*/
parent?: string;
}
export {};
}