v1.d.ts
80.7 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
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
/**
* 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 androiddeviceprovisioning_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;
}
/**
* Android Device Provisioning Partner API
*
* Automates Android zero-touch enrollment for device resellers, customers, and EMMs.
*
* @example
* const {google} = require('googleapis');
* const androiddeviceprovisioning = google.androiddeviceprovisioning('v1');
*
* @namespace androiddeviceprovisioning
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Androiddeviceprovisioning
*/
export class Androiddeviceprovisioning {
context: APIRequestContext;
customers: Resource$Customers;
operations: Resource$Operations;
partners: Resource$Partners;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Request message to claim a device on behalf of a customer.
*/
export interface Schema$ClaimDeviceRequest {
/**
* Required. The ID of the customer for whom the device is being claimed.
*/
customerId?: string | null;
/**
* Required. The device identifier of the device to claim.
*/
deviceIdentifier?: Schema$DeviceIdentifier;
/**
* Optional. The metadata to attach to the device.
*/
deviceMetadata?: Schema$DeviceMetadata;
/**
* Required. The section type of the device's provisioning record.
*/
sectionType?: string | null;
}
/**
* Response message containing device id of the claim.
*/
export interface Schema$ClaimDeviceResponse {
/**
* The device ID of the claimed device.
*/
deviceId?: string | null;
/**
* The resource name of the device in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
*/
deviceName?: string | null;
}
/**
* Request to claim devices asynchronously in batch. Claiming a device adds the device to zero-touch enrollment and shows the device in the customer's view of the portal.
*/
export interface Schema$ClaimDevicesRequest {
/**
* Required. A list of device claims.
*/
claims?: Schema$PartnerClaim[];
}
/**
* A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
*/
export interface Schema$Company {
/**
* Optional. Input only. Email address of customer's users in the admin role. Each email address must be associated with a Google Account.
*/
adminEmails?: string[] | null;
/**
* Output only. The ID of the company. Assigned by the server.
*/
companyId?: string | null;
/**
* Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.
*/
companyName?: string | null;
/**
* Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.
*/
name?: string | null;
/**
* Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Each email address must be associated with a Google Account. Owners share the same access as admins but can also add, delete, and edit your organization's portal users.
*/
ownerEmails?: string[] | null;
/**
* Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
*/
termsStatus?: string | null;
}
/**
* A configuration collects the provisioning options for Android devices. Each configuration combines the following: * The EMM device policy controller (DPC) installed on the devices. * EMM policies enforced on the devices. * Metadata displayed on the device to help users during setup. Customers can add as many configurations as they need. However, zero-touch enrollment works best when a customer sets a default configuration that's applied to any new devices the organization purchases.
*/
export interface Schema$Configuration {
/**
* Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning.
*/
companyName?: string | null;
/**
* Output only. The ID of the configuration. Assigned by the server.
*/
configurationId?: string | null;
/**
* Required. A short name that describes the configuration's purpose. For example, _Sales team_ or _Temporary employees_. The zero-touch enrollment portal displays this name to IT admins.
*/
configurationName?: string | null;
/**
* Required. The email address that device users can contact to get help. Zero-touch enrollment shows this email address to device users before device provisioning. The value is validated on input.
*/
contactEmail?: string | null;
/**
* Required. The telephone number that device users can call, using another device, to get help. Zero-touch enrollment shows this number to device users before device provisioning. Accepts numerals, spaces, the plus sign, hyphens, and parentheses.
*/
contactPhone?: string | null;
/**
* A message, containing one or two sentences, to help device users get help or give them more details about what’s happening to their device. Zero-touch enrollment shows this message before the device is provisioned.
*/
customMessage?: string | null;
/**
* The JSON-formatted EMM provisioning extras that are passed to the DPC.
*/
dpcExtras?: string | null;
/**
* Required. The resource name of the selected DPC (device policy controller) in the format `customers/[CUSTOMER_ID]/dpcs/x. To list the supported DPCs, call `customers.dpcs.list`.
*/
dpcResourcePath?: string | null;
/**
* Required. Whether this is the default configuration that zero-touch enrollment applies to any new devices the organization purchases in the future. Only one customer configuration can be the default. Setting this value to `true`, changes the previous default configuration's `isDefault` value to `false`.
*/
isDefault?: boolean | null;
/**
* Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server.
*/
name?: string | null;
}
/**
* Request message to create a customer.
*/
export interface Schema$CreateCustomerRequest {
/**
* Required. The company data to populate the new customer. Must contain a value for `companyName` and at least one `owner_email` that's associated with a Google Account. The values for `companyId` and `name` must be empty.
*/
customer?: Schema$Company;
}
/**
* Request message for customer to assign a configuration to device.
*/
export interface Schema$CustomerApplyConfigurationRequest {
/**
* Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
*/
configuration?: string | null;
/**
* Required. The device the configuration is applied to.
*/
device?: Schema$DeviceReference;
}
/**
* Response message of customer's listing configuration.
*/
export interface Schema$CustomerListConfigurationsResponse {
/**
* The configurations.
*/
configurations?: Schema$Configuration[];
}
/**
* Response message for listing my customers.
*/
export interface Schema$CustomerListCustomersResponse {
/**
* The customer accounts the calling user is a member of.
*/
customers?: Schema$Company[];
/**
* A token used to access the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string | null;
}
/**
* Response message of customer's liting devices.
*/
export interface Schema$CustomerListDevicesResponse {
/**
* The customer's devices.
*/
devices?: Schema$Device[];
/**
* A token used to access the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string | null;
}
/**
* Response message of customer's listing DPCs.
*/
export interface Schema$CustomerListDpcsResponse {
/**
* The list of DPCs available to the customer that support zero-touch enrollment.
*/
dpcs?: Schema$Dpc[];
}
/**
* Request message for customer to remove the configuration from device.
*/
export interface Schema$CustomerRemoveConfigurationRequest {
/**
* Required. The device to remove the configuration from.
*/
device?: Schema$DeviceReference;
}
/**
* Request message for customer to unclaim a device.
*/
export interface Schema$CustomerUnclaimDeviceRequest {
/**
* Required. The device to unclaim.
*/
device?: Schema$DeviceReference;
}
/**
* An Android device registered for zero-touch enrollment.
*/
export interface Schema$Device {
/**
* Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
*/
claims?: Schema$DeviceClaim[];
/**
* Not available to resellers.
*/
configuration?: string | null;
/**
* Output only. The ID of the device. Assigned by the server.
*/
deviceId?: string | null;
/**
* The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](/zero-touch/guides/identifiers).
*/
deviceIdentifier?: Schema$DeviceIdentifier;
/**
* The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](/zero-touch/guides/metadata).
*/
deviceMetadata?: Schema$DeviceMetadata;
/**
* Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
*/
name?: string | null;
}
/**
* A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
*/
export interface Schema$DeviceClaim {
/**
* The ID of the Customer that purchased the device.
*/
ownerCompanyId?: string | null;
/**
* The ID of the reseller that claimed the device.
*/
resellerId?: string | null;
/**
* Output only. The type of claim made on the device.
*/
sectionType?: string | null;
/**
* The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
*/
vacationModeExpireTime?: string | null;
/**
* The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
*/
vacationModeStartTime?: string | null;
}
/**
* Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](/zero-touch/guides/identifiers).
*/
export interface Schema$DeviceIdentifier {
/**
* The device’s IMEI number. Validated on input.
*/
imei?: string | null;
/**
* The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
*/
manufacturer?: string | null;
/**
* The device’s MEID number.
*/
meid?: string | null;
/**
* The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
*/
model?: string | null;
/**
* The manufacturer's serial number for the device. This value might not be unique across different device models.
*/
serialNumber?: string | null;
}
/**
* Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](/zero-touch/guides/metadata).
*/
export interface Schema$DeviceMetadata {
/**
* Metadata entries recorded as key-value pairs.
*/
entries?: {
[key: string]: string;
} | null;
}
/**
* A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it's more flexible for the caller. To learn more about device identifiers, read [Identifiers](/zero-touch/guides/identifiers).
*/
export interface Schema$DeviceReference {
/**
* The ID of the device.
*/
deviceId?: string | null;
/**
* The hardware IDs of the device.
*/
deviceIdentifier?: Schema$DeviceIdentifier;
}
/**
* Tracks the status of a long-running operation to asynchronously update a batch of reseller metadata attached to devices. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
*/
export interface Schema$DevicesLongRunningOperationMetadata {
/**
* The number of metadata updates in the operation. This might be different from the number of updates in the request if the API can't parse some of the updates.
*/
devicesCount?: number | null;
/**
* The processing status of the operation.
*/
processingStatus?: string | null;
/**
* The processing progress of the operation. Measured as a number from 0 to 100. A value of 10O doesnt always mean the operation completed—check for the inclusion of a `done` field.
*/
progress?: number | null;
}
/**
* Tracks the status of a long-running operation to claim, unclaim, or attach metadata to devices. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
*/
export interface Schema$DevicesLongRunningOperationResponse {
/**
* The processing status for each device in the operation. One `PerDeviceStatus` per device. The list order matches the items in the original request.
*/
perDeviceStatus?: Schema$OperationPerDevice[];
/**
* A summary of how many items in the operation the server processed successfully. Updated as the operation progresses.
*/
successCount?: number | null;
}
/**
* An EMM's DPC ([device policy controller](http://developer.android.com/work/dpc/build-dpc.html)). Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a device to maintain the customer's mobile policies. All the DPCs listed by the API support zero-touch enrollment and are available in Google Play.
*/
export interface Schema$Dpc {
/**
* Output only. The title of the DPC app in Google Play. For example, _Google Apps Device Policy_. Useful in an application's user interface.
*/
dpcName?: string | null;
/**
* Output only. The API resource name in the format `customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by the server. To maintain a reference to a DPC across customer accounts, persist and match the last path component (`DPC_ID`).
*/
name?: string | null;
/**
* Output only. The DPC's Android application ID that looks like a Java package name. Zero-touch enrollment installs the DPC app onto a device using this identifier.
*/
packageName?: 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 to find devices.
*/
export interface Schema$FindDevicesByDeviceIdentifierRequest {
/**
* Required. The device identifier to search for.
*/
deviceIdentifier?: Schema$DeviceIdentifier;
/**
* Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
*/
limit?: string | null;
/**
* A token specifying which result page to return.
*/
pageToken?: string | null;
}
/**
* Response containing found devices.
*/
export interface Schema$FindDevicesByDeviceIdentifierResponse {
/**
* Found devices.
*/
devices?: Schema$Device[];
/**
* A token used to access the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string | null;
/**
* The total count of items in the list irrespective of pagination.
*/
totalSize?: number | null;
}
/**
* Request to find devices by customers.
*/
export interface Schema$FindDevicesByOwnerRequest {
/**
* Required. The list of customer IDs to search for.
*/
customerId?: string[] | null;
/**
* Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
*/
limit?: string | null;
/**
* A token specifying which result page to return.
*/
pageToken?: string | null;
/**
* Required. The section type of the device's provisioning record.
*/
sectionType?: string | null;
}
/**
* Response containing found devices.
*/
export interface Schema$FindDevicesByOwnerResponse {
/**
* The customer's devices.
*/
devices?: Schema$Device[];
/**
* A token used to access the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string | null;
/**
* The total count of items in the list irrespective of pagination.
*/
totalSize?: number | null;
}
/**
* Response message of all customers related to this partner.
*/
export interface Schema$ListCustomersResponse {
/**
* List of customers related to this reseller partner.
*/
customers?: Schema$Company[];
/**
* A token to retrieve the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string | null;
/**
* The total count of items in the list irrespective of pagination.
*/
totalSize?: number | null;
}
/**
* Response message to list customers of the vendor.
*/
export interface Schema$ListVendorCustomersResponse {
/**
* List of customers of the vendor.
*/
customers?: Schema$Company[];
/**
* A token to retrieve the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string | null;
/**
* The total count of items in the list irrespective of pagination.
*/
totalSize?: number | null;
}
/**
* Response message to list vendors of the partner.
*/
export interface Schema$ListVendorsResponse {
/**
* A token to retrieve the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string | null;
/**
* The total count of items in the list irrespective of pagination.
*/
totalSize?: number | null;
/**
* List of vendors of the reseller partner. Fields `name`, `companyId` and `companyName` are populated to the Company object.
*/
vendors?: Schema$Company[];
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
*/
error?: Schema$Status;
/**
* This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
*/
name?: string | null;
/**
* This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* A task for each device in the operation. Corresponds to each device change in the request.
*/
export interface Schema$OperationPerDevice {
/**
* A copy of the original device-claim request received by the server.
*/
claim?: Schema$PartnerClaim;
/**
* The processing result for each device.
*/
result?: Schema$PerDeviceStatusInBatch;
/**
* A copy of the original device-unclaim request received by the server.
*/
unclaim?: Schema$PartnerUnclaim;
/**
* A copy of the original metadata-update request received by the server.
*/
updateMetadata?: Schema$UpdateMetadataArguments;
}
/**
* Identifies one claim request.
*/
export interface Schema$PartnerClaim {
/**
* Required. The ID of the customer for whom the device is being claimed.
*/
customerId?: string | null;
/**
* Required. Device identifier of the device.
*/
deviceIdentifier?: Schema$DeviceIdentifier;
/**
* Required. The metadata to attach to the device at claim.
*/
deviceMetadata?: Schema$DeviceMetadata;
/**
* Required. The section type of the device's provisioning record.
*/
sectionType?: string | null;
}
/**
* Identifies one unclaim request.
*/
export interface Schema$PartnerUnclaim {
/**
* Device ID of the device.
*/
deviceId?: string | null;
/**
* Device identifier of the device.
*/
deviceIdentifier?: Schema$DeviceIdentifier;
/**
* Required. The section type of the device's provisioning record.
*/
sectionType?: string | null;
/**
* The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
*/
vacationModeDays?: number | null;
/**
* The expiration time of the vacation unlock.
*/
vacationModeExpireTime?: string | null;
}
/**
* Captures the processing status for each device in the operation.
*/
export interface Schema$PerDeviceStatusInBatch {
/**
* If processing succeeds, the device ID of the device.
*/
deviceId?: string | null;
/**
* If processing fails, the error type.
*/
errorIdentifier?: string | null;
/**
* If processing fails, a developer message explaining what went wrong.
*/
errorMessage?: string | null;
/**
* The result status of the device after processing.
*/
status?: string | null;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* Request message to unclaim a device.
*/
export interface Schema$UnclaimDeviceRequest {
/**
* The device ID returned by `ClaimDevice`.
*/
deviceId?: string | null;
/**
* The device identifier you used when you claimed this device.
*/
deviceIdentifier?: Schema$DeviceIdentifier;
/**
* Required. The section type of the device's provisioning record.
*/
sectionType?: string | null;
/**
* The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
*/
vacationModeDays?: number | null;
/**
* The expiration time of the vacation unlock.
*/
vacationModeExpireTime?: string | null;
}
/**
* Request to unclaim devices asynchronously in batch.
*/
export interface Schema$UnclaimDevicesRequest {
/**
* Required. The list of devices to unclaim.
*/
unclaims?: Schema$PartnerUnclaim[];
}
/**
* Request to update device metadata in batch.
*/
export interface Schema$UpdateDeviceMetadataInBatchRequest {
/**
* Required. The list of metadata updates.
*/
updates?: Schema$UpdateMetadataArguments[];
}
/**
* Request to set metadata for a device.
*/
export interface Schema$UpdateDeviceMetadataRequest {
/**
* Required. The metdata to attach to the device.
*/
deviceMetadata?: Schema$DeviceMetadata;
}
/**
* Identifies metdata updates to one device.
*/
export interface Schema$UpdateMetadataArguments {
/**
* Device ID of the device.
*/
deviceId?: string | null;
/**
* Device identifier.
*/
deviceIdentifier?: Schema$DeviceIdentifier;
/**
* Required. The metadata to update.
*/
deviceMetadata?: Schema$DeviceMetadata;
}
export class Resource$Customers {
context: APIRequestContext;
configurations: Resource$Customers$Configurations;
devices: Resource$Customers$Devices;
dpcs: Resource$Customers$Dpcs;
constructor(context: APIRequestContext);
/**
* androiddeviceprovisioning.customers.list
* @desc Lists the user's customer accounts.
* @alias androiddeviceprovisioning.customers.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive).
* @param {string=} params.pageToken A token specifying which result page to return.
* @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
*/
list(params?: Params$Resource$Customers$List, options?: MethodOptions): GaxiosPromise<Schema$CustomerListCustomersResponse>;
list(params: Params$Resource$Customers$List, options: MethodOptions | BodyResponseCallback<Schema$CustomerListCustomersResponse>, callback: BodyResponseCallback<Schema$CustomerListCustomersResponse>): void;
list(params: Params$Resource$Customers$List, callback: BodyResponseCallback<Schema$CustomerListCustomersResponse>): void;
list(callback: BodyResponseCallback<Schema$CustomerListCustomersResponse>): void;
}
export interface Params$Resource$Customers$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive).
*/
pageSize?: number;
/**
* A token specifying which result page to return.
*/
pageToken?: string;
}
export class Resource$Customers$Configurations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androiddeviceprovisioning.customers.configurations.create
* @desc Creates a new configuration. Once created, a customer can apply the configuration to devices.
* @alias androiddeviceprovisioning.customers.configurations.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The customer that manages the configuration. An API resource name in the format `customers/[CUSTOMER_ID]`.
* @param {().Configuration} 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
*/
create(params?: Params$Resource$Customers$Configurations$Create, options?: MethodOptions): GaxiosPromise<Schema$Configuration>;
create(params: Params$Resource$Customers$Configurations$Create, options: MethodOptions | BodyResponseCallback<Schema$Configuration>, callback: BodyResponseCallback<Schema$Configuration>): void;
create(params: Params$Resource$Customers$Configurations$Create, callback: BodyResponseCallback<Schema$Configuration>): void;
create(callback: BodyResponseCallback<Schema$Configuration>): void;
/**
* androiddeviceprovisioning.customers.configurations.delete
* @desc Deletes an unused configuration. The API call fails if the customer has devices with the configuration applied.
* @alias androiddeviceprovisioning.customers.configurations.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The configuration to delete. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the configuration is applied to any devices, the API call fails.
* @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$Customers$Configurations$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Customers$Configurations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Customers$Configurations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* androiddeviceprovisioning.customers.configurations.get
* @desc Gets the details of a configuration.
* @alias androiddeviceprovisioning.customers.configurations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The configuration to get. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
* @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
*/
get(params?: Params$Resource$Customers$Configurations$Get, options?: MethodOptions): GaxiosPromise<Schema$Configuration>;
get(params: Params$Resource$Customers$Configurations$Get, options: MethodOptions | BodyResponseCallback<Schema$Configuration>, callback: BodyResponseCallback<Schema$Configuration>): void;
get(params: Params$Resource$Customers$Configurations$Get, callback: BodyResponseCallback<Schema$Configuration>): void;
get(callback: BodyResponseCallback<Schema$Configuration>): void;
/**
* androiddeviceprovisioning.customers.configurations.list
* @desc Lists a customer's configurations.
* @alias androiddeviceprovisioning.customers.configurations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The customer that manages the listed configurations. An API resource name in the format `customers/[CUSTOMER_ID]`.
* @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
*/
list(params?: Params$Resource$Customers$Configurations$List, options?: MethodOptions): GaxiosPromise<Schema$CustomerListConfigurationsResponse>;
list(params: Params$Resource$Customers$Configurations$List, options: MethodOptions | BodyResponseCallback<Schema$CustomerListConfigurationsResponse>, callback: BodyResponseCallback<Schema$CustomerListConfigurationsResponse>): void;
list(params: Params$Resource$Customers$Configurations$List, callback: BodyResponseCallback<Schema$CustomerListConfigurationsResponse>): void;
list(callback: BodyResponseCallback<Schema$CustomerListConfigurationsResponse>): void;
/**
* androiddeviceprovisioning.customers.configurations.patch
* @desc Updates a configuration's field values.
* @alias androiddeviceprovisioning.customers.configurations.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server.
* @param {string=} params.updateMask Required. The field mask applied to the target `Configuration` before updating the fields. To learn more about using field masks, read [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in the Protocol Buffers documentation.
* @param {().Configuration} 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
*/
patch(params?: Params$Resource$Customers$Configurations$Patch, options?: MethodOptions): GaxiosPromise<Schema$Configuration>;
patch(params: Params$Resource$Customers$Configurations$Patch, options: MethodOptions | BodyResponseCallback<Schema$Configuration>, callback: BodyResponseCallback<Schema$Configuration>): void;
patch(params: Params$Resource$Customers$Configurations$Patch, callback: BodyResponseCallback<Schema$Configuration>): void;
patch(callback: BodyResponseCallback<Schema$Configuration>): void;
}
export interface Params$Resource$Customers$Configurations$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The customer that manages the configuration. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Configuration;
}
export interface Params$Resource$Customers$Configurations$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The configuration to delete. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the configuration is applied to any devices, the API call fails.
*/
name?: string;
}
export interface Params$Resource$Customers$Configurations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The configuration to get. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
*/
name?: string;
}
export interface Params$Resource$Customers$Configurations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The customer that manages the listed configurations. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
}
export interface Params$Resource$Customers$Configurations$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server.
*/
name?: string;
/**
* Required. The field mask applied to the target `Configuration` before updating the fields. To learn more about using field masks, read [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in the Protocol Buffers documentation.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Configuration;
}
export class Resource$Customers$Devices {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androiddeviceprovisioning.customers.devices.applyConfiguration
* @desc Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.
* @alias androiddeviceprovisioning.customers.devices.applyConfiguration
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`.
* @param {().CustomerApplyConfigurationRequest} 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
*/
applyConfiguration(params?: Params$Resource$Customers$Devices$Applyconfiguration, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
applyConfiguration(params: Params$Resource$Customers$Devices$Applyconfiguration, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
applyConfiguration(params: Params$Resource$Customers$Devices$Applyconfiguration, callback: BodyResponseCallback<Schema$Empty>): void;
applyConfiguration(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* androiddeviceprovisioning.customers.devices.get
* @desc Gets the details of a device.
* @alias androiddeviceprovisioning.customers.devices.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The device to get. An API resource name in the format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`.
* @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
*/
get(params?: Params$Resource$Customers$Devices$Get, options?: MethodOptions): GaxiosPromise<Schema$Device>;
get(params: Params$Resource$Customers$Devices$Get, options: MethodOptions | BodyResponseCallback<Schema$Device>, callback: BodyResponseCallback<Schema$Device>): void;
get(params: Params$Resource$Customers$Devices$Get, callback: BodyResponseCallback<Schema$Device>): void;
get(callback: BodyResponseCallback<Schema$Device>): void;
/**
* androiddeviceprovisioning.customers.devices.list
* @desc Lists a customer's devices.
* @alias androiddeviceprovisioning.customers.devices.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.pageSize The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
* @param {string=} params.pageToken A token specifying which result page to return.
* @param {string} params.parent Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`.
* @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
*/
list(params?: Params$Resource$Customers$Devices$List, options?: MethodOptions): GaxiosPromise<Schema$CustomerListDevicesResponse>;
list(params: Params$Resource$Customers$Devices$List, options: MethodOptions | BodyResponseCallback<Schema$CustomerListDevicesResponse>, callback: BodyResponseCallback<Schema$CustomerListDevicesResponse>): void;
list(params: Params$Resource$Customers$Devices$List, callback: BodyResponseCallback<Schema$CustomerListDevicesResponse>): void;
list(callback: BodyResponseCallback<Schema$CustomerListDevicesResponse>): void;
/**
* androiddeviceprovisioning.customers.devices.removeConfiguration
* @desc Removes a configuration from device.
* @alias androiddeviceprovisioning.customers.devices.removeConfiguration
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The customer managing the device in the format `customers/[CUSTOMER_ID]`.
* @param {().CustomerRemoveConfigurationRequest} 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
*/
removeConfiguration(params?: Params$Resource$Customers$Devices$Removeconfiguration, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
removeConfiguration(params: Params$Resource$Customers$Devices$Removeconfiguration, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
removeConfiguration(params: Params$Resource$Customers$Devices$Removeconfiguration, callback: BodyResponseCallback<Schema$Empty>): void;
removeConfiguration(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* androiddeviceprovisioning.customers.devices.unclaim
* @desc Unclaims a device from a customer and removes it from zero-touch enrollment. After removing a device, a customer must contact their reseller to register the device into zero-touch enrollment again.
* @alias androiddeviceprovisioning.customers.devices.unclaim
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`.
* @param {().CustomerUnclaimDeviceRequest} 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
*/
unclaim(params?: Params$Resource$Customers$Devices$Unclaim, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
unclaim(params: Params$Resource$Customers$Devices$Unclaim, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
unclaim(params: Params$Resource$Customers$Devices$Unclaim, callback: BodyResponseCallback<Schema$Empty>): void;
unclaim(callback: BodyResponseCallback<Schema$Empty>): void;
}
export interface Params$Resource$Customers$Devices$Applyconfiguration extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CustomerApplyConfigurationRequest;
}
export interface Params$Resource$Customers$Devices$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The device to get. An API resource name in the format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`.
*/
name?: string;
}
export interface Params$Resource$Customers$Devices$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
*/
pageSize?: string;
/**
* A token specifying which result page to return.
*/
pageToken?: string;
/**
* Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
}
export interface Params$Resource$Customers$Devices$Removeconfiguration extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The customer managing the device in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CustomerRemoveConfigurationRequest;
}
export interface Params$Resource$Customers$Devices$Unclaim extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CustomerUnclaimDeviceRequest;
}
export class Resource$Customers$Dpcs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androiddeviceprovisioning.customers.dpcs.list
* @desc Lists the DPCs (device policy controllers) that support zero-touch enrollment.
* @alias androiddeviceprovisioning.customers.dpcs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The customer that can use the DPCs in configurations. An API resource name in the format `customers/[CUSTOMER_ID]`.
* @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
*/
list(params?: Params$Resource$Customers$Dpcs$List, options?: MethodOptions): GaxiosPromise<Schema$CustomerListDpcsResponse>;
list(params: Params$Resource$Customers$Dpcs$List, options: MethodOptions | BodyResponseCallback<Schema$CustomerListDpcsResponse>, callback: BodyResponseCallback<Schema$CustomerListDpcsResponse>): void;
list(params: Params$Resource$Customers$Dpcs$List, callback: BodyResponseCallback<Schema$CustomerListDpcsResponse>): void;
list(callback: BodyResponseCallback<Schema$CustomerListDpcsResponse>): void;
}
export interface Params$Resource$Customers$Dpcs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The customer that can use the DPCs in configurations. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
}
export class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androiddeviceprovisioning.operations.get
* @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias androiddeviceprovisioning.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @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
*/
get(params?: Params$Resource$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
export class Resource$Partners {
context: APIRequestContext;
customers: Resource$Partners$Customers;
devices: Resource$Partners$Devices;
vendors: Resource$Partners$Vendors;
constructor(context: APIRequestContext);
}
export class Resource$Partners$Customers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androiddeviceprovisioning.partners.customers.create
* @desc Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.
* @alias androiddeviceprovisioning.partners.customers.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The parent resource ID in the format `partners/[PARTNER_ID]` that identifies the reseller.
* @param {().CreateCustomerRequest} 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
*/
create(params?: Params$Resource$Partners$Customers$Create, options?: MethodOptions): GaxiosPromise<Schema$Company>;
create(params: Params$Resource$Partners$Customers$Create, options: MethodOptions | BodyResponseCallback<Schema$Company>, callback: BodyResponseCallback<Schema$Company>): void;
create(params: Params$Resource$Partners$Customers$Create, callback: BodyResponseCallback<Schema$Company>): void;
create(callback: BodyResponseCallback<Schema$Company>): void;
/**
* androiddeviceprovisioning.partners.customers.list
* @desc Lists the customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.
* @alias androiddeviceprovisioning.partners.customers.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of results to be returned. If not specified or 0, all the records are returned.
* @param {string=} params.pageToken A token identifying a page of results returned by the server.
* @param {string} params.partnerId Required. The ID of the reseller partner.
* @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
*/
list(params?: Params$Resource$Partners$Customers$List, options?: MethodOptions): GaxiosPromise<Schema$ListCustomersResponse>;
list(params: Params$Resource$Partners$Customers$List, options: MethodOptions | BodyResponseCallback<Schema$ListCustomersResponse>, callback: BodyResponseCallback<Schema$ListCustomersResponse>): void;
list(params: Params$Resource$Partners$Customers$List, callback: BodyResponseCallback<Schema$ListCustomersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCustomersResponse>): void;
}
export interface Params$Resource$Partners$Customers$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The parent resource ID in the format `partners/[PARTNER_ID]` that identifies the reseller.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreateCustomerRequest;
}
export interface Params$Resource$Partners$Customers$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of results to be returned. If not specified or 0, all the records are returned.
*/
pageSize?: number;
/**
* A token identifying a page of results returned by the server.
*/
pageToken?: string;
/**
* Required. The ID of the reseller partner.
*/
partnerId?: string;
}
export class Resource$Partners$Devices {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androiddeviceprovisioning.partners.devices.claim
* @desc Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.
* @alias androiddeviceprovisioning.partners.devices.claim
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.partnerId Required. The ID of the reseller partner.
* @param {().ClaimDeviceRequest} 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
*/
claim(params?: Params$Resource$Partners$Devices$Claim, options?: MethodOptions): GaxiosPromise<Schema$ClaimDeviceResponse>;
claim(params: Params$Resource$Partners$Devices$Claim, options: MethodOptions | BodyResponseCallback<Schema$ClaimDeviceResponse>, callback: BodyResponseCallback<Schema$ClaimDeviceResponse>): void;
claim(params: Params$Resource$Partners$Devices$Claim, callback: BodyResponseCallback<Schema$ClaimDeviceResponse>): void;
claim(callback: BodyResponseCallback<Schema$ClaimDeviceResponse>): void;
/**
* androiddeviceprovisioning.partners.devices.claimAsync
* @desc Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
* @alias androiddeviceprovisioning.partners.devices.claimAsync
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.partnerId Required. The ID of the reseller partner.
* @param {().ClaimDevicesRequest} 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
*/
claimAsync(params?: Params$Resource$Partners$Devices$Claimasync, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
claimAsync(params: Params$Resource$Partners$Devices$Claimasync, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
claimAsync(params: Params$Resource$Partners$Devices$Claimasync, callback: BodyResponseCallback<Schema$Operation>): void;
claimAsync(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* androiddeviceprovisioning.partners.devices.findByIdentifier
* @desc Finds devices by hardware identifiers, such as IMEI.
* @alias androiddeviceprovisioning.partners.devices.findByIdentifier
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.partnerId Required. The ID of the reseller partner.
* @param {().FindDevicesByDeviceIdentifierRequest} 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
*/
findByIdentifier(params?: Params$Resource$Partners$Devices$Findbyidentifier, options?: MethodOptions): GaxiosPromise<Schema$FindDevicesByDeviceIdentifierResponse>;
findByIdentifier(params: Params$Resource$Partners$Devices$Findbyidentifier, options: MethodOptions | BodyResponseCallback<Schema$FindDevicesByDeviceIdentifierResponse>, callback: BodyResponseCallback<Schema$FindDevicesByDeviceIdentifierResponse>): void;
findByIdentifier(params: Params$Resource$Partners$Devices$Findbyidentifier, callback: BodyResponseCallback<Schema$FindDevicesByDeviceIdentifierResponse>): void;
findByIdentifier(callback: BodyResponseCallback<Schema$FindDevicesByDeviceIdentifierResponse>): void;
/**
* androiddeviceprovisioning.partners.devices.findByOwner
* @desc Finds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the `partnerId` argument. The customer's devices purchased from other resellers don't appear in the results.
* @alias androiddeviceprovisioning.partners.devices.findByOwner
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.partnerId Required. The ID of the reseller partner.
* @param {().FindDevicesByOwnerRequest} 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
*/
findByOwner(params?: Params$Resource$Partners$Devices$Findbyowner, options?: MethodOptions): GaxiosPromise<Schema$FindDevicesByOwnerResponse>;
findByOwner(params: Params$Resource$Partners$Devices$Findbyowner, options: MethodOptions | BodyResponseCallback<Schema$FindDevicesByOwnerResponse>, callback: BodyResponseCallback<Schema$FindDevicesByOwnerResponse>): void;
findByOwner(params: Params$Resource$Partners$Devices$Findbyowner, callback: BodyResponseCallback<Schema$FindDevicesByOwnerResponse>): void;
findByOwner(callback: BodyResponseCallback<Schema$FindDevicesByOwnerResponse>): void;
/**
* androiddeviceprovisioning.partners.devices.get
* @desc Gets a device.
* @alias androiddeviceprovisioning.partners.devices.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The device API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
* @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
*/
get(params?: Params$Resource$Partners$Devices$Get, options?: MethodOptions): GaxiosPromise<Schema$Device>;
get(params: Params$Resource$Partners$Devices$Get, options: MethodOptions | BodyResponseCallback<Schema$Device>, callback: BodyResponseCallback<Schema$Device>): void;
get(params: Params$Resource$Partners$Devices$Get, callback: BodyResponseCallback<Schema$Device>): void;
get(callback: BodyResponseCallback<Schema$Device>): void;
/**
* androiddeviceprovisioning.partners.devices.metadata
* @desc Updates reseller metadata associated with the device.
* @alias androiddeviceprovisioning.partners.devices.metadata
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.deviceId Required. The ID of the device.
* @param {string} params.metadataOwnerId Required. The owner of the newly set metadata. Set this to the partner ID.
* @param {().UpdateDeviceMetadataRequest} 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
*/
metadata(params?: Params$Resource$Partners$Devices$Metadata, options?: MethodOptions): GaxiosPromise<Schema$DeviceMetadata>;
metadata(params: Params$Resource$Partners$Devices$Metadata, options: MethodOptions | BodyResponseCallback<Schema$DeviceMetadata>, callback: BodyResponseCallback<Schema$DeviceMetadata>): void;
metadata(params: Params$Resource$Partners$Devices$Metadata, callback: BodyResponseCallback<Schema$DeviceMetadata>): void;
metadata(callback: BodyResponseCallback<Schema$DeviceMetadata>): void;
/**
* androiddeviceprovisioning.partners.devices.unclaim
* @desc Unclaims a device from a customer and removes it from zero-touch enrollment.
* @alias androiddeviceprovisioning.partners.devices.unclaim
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.partnerId Required. The ID of the reseller partner.
* @param {().UnclaimDeviceRequest} 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
*/
unclaim(params?: Params$Resource$Partners$Devices$Unclaim, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
unclaim(params: Params$Resource$Partners$Devices$Unclaim, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
unclaim(params: Params$Resource$Partners$Devices$Unclaim, callback: BodyResponseCallback<Schema$Empty>): void;
unclaim(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* androiddeviceprovisioning.partners.devices.unclaimAsync
* @desc Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
* @alias androiddeviceprovisioning.partners.devices.unclaimAsync
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.partnerId Required. The reseller partner ID.
* @param {().UnclaimDevicesRequest} 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
*/
unclaimAsync(params?: Params$Resource$Partners$Devices$Unclaimasync, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
unclaimAsync(params: Params$Resource$Partners$Devices$Unclaimasync, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
unclaimAsync(params: Params$Resource$Partners$Devices$Unclaimasync, callback: BodyResponseCallback<Schema$Operation>): void;
unclaimAsync(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* androiddeviceprovisioning.partners.devices.updateMetadataAsync
* @desc Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
* @alias androiddeviceprovisioning.partners.devices.updateMetadataAsync
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.partnerId Required. The reseller partner ID.
* @param {().UpdateDeviceMetadataInBatchRequest} 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
*/
updateMetadataAsync(params?: Params$Resource$Partners$Devices$Updatemetadataasync, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
updateMetadataAsync(params: Params$Resource$Partners$Devices$Updatemetadataasync, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
updateMetadataAsync(params: Params$Resource$Partners$Devices$Updatemetadataasync, callback: BodyResponseCallback<Schema$Operation>): void;
updateMetadataAsync(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Partners$Devices$Claim extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The ID of the reseller partner.
*/
partnerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ClaimDeviceRequest;
}
export interface Params$Resource$Partners$Devices$Claimasync extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The ID of the reseller partner.
*/
partnerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ClaimDevicesRequest;
}
export interface Params$Resource$Partners$Devices$Findbyidentifier extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The ID of the reseller partner.
*/
partnerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FindDevicesByDeviceIdentifierRequest;
}
export interface Params$Resource$Partners$Devices$Findbyowner extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The ID of the reseller partner.
*/
partnerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FindDevicesByOwnerRequest;
}
export interface Params$Resource$Partners$Devices$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The device API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
*/
name?: string;
}
export interface Params$Resource$Partners$Devices$Metadata extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The ID of the device.
*/
deviceId?: string;
/**
* Required. The owner of the newly set metadata. Set this to the partner ID.
*/
metadataOwnerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateDeviceMetadataRequest;
}
export interface Params$Resource$Partners$Devices$Unclaim extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The ID of the reseller partner.
*/
partnerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UnclaimDeviceRequest;
}
export interface Params$Resource$Partners$Devices$Unclaimasync extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The reseller partner ID.
*/
partnerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UnclaimDevicesRequest;
}
export interface Params$Resource$Partners$Devices$Updatemetadataasync extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The reseller partner ID.
*/
partnerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateDeviceMetadataInBatchRequest;
}
export class Resource$Partners$Vendors {
context: APIRequestContext;
customers: Resource$Partners$Vendors$Customers;
constructor(context: APIRequestContext);
/**
* androiddeviceprovisioning.partners.vendors.list
* @desc Lists the vendors of the partner.
* @alias androiddeviceprovisioning.partners.vendors.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of results to be returned.
* @param {string=} params.pageToken A token identifying a page of results returned by the server.
* @param {string} params.parent Required. The resource name in the format `partners/[PARTNER_ID]`.
* @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
*/
list(params?: Params$Resource$Partners$Vendors$List, options?: MethodOptions): GaxiosPromise<Schema$ListVendorsResponse>;
list(params: Params$Resource$Partners$Vendors$List, options: MethodOptions | BodyResponseCallback<Schema$ListVendorsResponse>, callback: BodyResponseCallback<Schema$ListVendorsResponse>): void;
list(params: Params$Resource$Partners$Vendors$List, callback: BodyResponseCallback<Schema$ListVendorsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListVendorsResponse>): void;
}
export interface Params$Resource$Partners$Vendors$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of results to be returned.
*/
pageSize?: number;
/**
* A token identifying a page of results returned by the server.
*/
pageToken?: string;
/**
* Required. The resource name in the format `partners/[PARTNER_ID]`.
*/
parent?: string;
}
export class Resource$Partners$Vendors$Customers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androiddeviceprovisioning.partners.vendors.customers.list
* @desc Lists the customers of the vendor.
* @alias androiddeviceprovisioning.partners.vendors.customers.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of results to be returned.
* @param {string=} params.pageToken A token identifying a page of results returned by the server.
* @param {string} params.parent Required. The resource name in the format `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`.
* @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
*/
list(params?: Params$Resource$Partners$Vendors$Customers$List, options?: MethodOptions): GaxiosPromise<Schema$ListVendorCustomersResponse>;
list(params: Params$Resource$Partners$Vendors$Customers$List, options: MethodOptions | BodyResponseCallback<Schema$ListVendorCustomersResponse>, callback: BodyResponseCallback<Schema$ListVendorCustomersResponse>): void;
list(params: Params$Resource$Partners$Vendors$Customers$List, callback: BodyResponseCallback<Schema$ListVendorCustomersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListVendorCustomersResponse>): void;
}
export interface Params$Resource$Partners$Vendors$Customers$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of results to be returned.
*/
pageSize?: number;
/**
* A token identifying a page of results returned by the server.
*/
pageToken?: string;
/**
* Required. The resource name in the format `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`.
*/
parent?: string;
}
export {};
}