v1.d.ts
75.4 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
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
/**
* 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 { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace people_v1 {
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;
}
/**
* People API
*
* Provides access to information about profiles and contacts.
*
* @example
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* @namespace people
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for People
*/
class People {
context: APIRequestContext;
contactGroups: Resource$Contactgroups;
people: Resource$People;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A person's physical address. May be a P.O. box or street address. All
* fields are optional.
*/
interface Schema$Address {
/**
* The city of the address.
*/
city?: string;
/**
* The country of the address.
*/
country?: string;
/**
* The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm)
* country code of the address.
*/
countryCode?: string;
/**
* The extended address of the address; for example, the apartment number.
*/
extendedAddress?: string;
/**
* The read-only type of the address translated and formatted in the
* viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string;
/**
* The unstructured value of the address. If this is not set by the user it
* will be automatically constructed from structured values.
*/
formattedValue?: string;
/**
* Metadata about the address.
*/
metadata?: Schema$FieldMetadata;
/**
* The P.O. box of the address.
*/
poBox?: string;
/**
* The postal code of the address.
*/
postalCode?: string;
/**
* The region of the address; for example, the state or province.
*/
region?: string;
/**
* The street address.
*/
streetAddress?: string;
/**
* The type of the address. The type can be custom or one of these
* predefined values: * `home` * `work` * `other`
*/
type?: string;
}
/**
* A person's age range.
*/
interface Schema$AgeRangeType {
/**
* The age range.
*/
ageRange?: string;
/**
* Metadata about the age range.
*/
metadata?: Schema$FieldMetadata;
}
/**
* The response to a batch get contact groups request.
*/
interface Schema$BatchGetContactGroupsResponse {
/**
* The list of responses for each requested contact group resource.
*/
responses?: Schema$ContactGroupResponse[];
}
/**
* A person's short biography.
*/
interface Schema$Biography {
/**
* The content type of the biography.
*/
contentType?: string;
/**
* Metadata about the biography.
*/
metadata?: Schema$FieldMetadata;
/**
* The short biography.
*/
value?: string;
}
/**
* A person's birthday. At least one of the `date` and `text` fields are
* specified. The `date` and `text` fields typically represent the same date,
* but are not guaranteed to.
*/
interface Schema$Birthday {
/**
* The date of the birthday.
*/
date?: Schema$Date;
/**
* Metadata about the birthday.
*/
metadata?: Schema$FieldMetadata;
/**
* A free-form string representing the user's birthday.
*/
text?: string;
}
/**
* A person's bragging rights.
*/
interface Schema$BraggingRights {
/**
* Metadata about the bragging rights.
*/
metadata?: Schema$FieldMetadata;
/**
* The bragging rights; for example, `climbed mount everest`.
*/
value?: string;
}
/**
* A contact group.
*/
interface Schema$ContactGroup {
/**
* The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
* resource. Used for web cache validation.
*/
etag?: string;
/**
* The read-only name translated and formatted in the viewer's account
* locale or the `Accept-Language` HTTP header locale for system groups
* names. Group names set by the owner are the same as name.
*/
formattedName?: string;
/**
* The read-only contact group type.
*/
groupType?: string;
/**
* The total number of contacts in the group irrespective of max members in
* specified in the request.
*/
memberCount?: number;
/**
* The list of contact person resource names that are members of the contact
* group. The field is not populated for LIST requests and can only be
* updated through the
* [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
*/
memberResourceNames?: string[];
/**
* Metadata about the contact group.
*/
metadata?: Schema$ContactGroupMetadata;
/**
* The contact group name set by the group owner or a system provided name
* for system groups.
*/
name?: string;
/**
* The resource name for the contact group, assigned by the server. An ASCII
* string, in the form of
* `contactGroups/`<var>contact_group_id</var>.
*/
resourceName?: string;
}
/**
* A Google contact group membership.
*/
interface Schema$ContactGroupMembership {
/**
* The contact group ID for the contact group membership. The contact group
* ID can be custom or one of these predefined values: * `myContacts` *
* `starred` * A numerical ID for user-created groups.
*/
contactGroupId?: string;
}
/**
* The read-only metadata about a contact group.
*/
interface Schema$ContactGroupMetadata {
/**
* True if the contact group resource has been deleted. Populated only for
* [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
* that include a sync token.
*/
deleted?: boolean;
/**
* The time the group was last updated.
*/
updateTime?: string;
}
/**
* The response for a specific contact group.
*/
interface Schema$ContactGroupResponse {
/**
* The contact group.
*/
contactGroup?: Schema$ContactGroup;
/**
* The original requested resource name.
*/
requestedResourceName?: string;
/**
* The status of the response.
*/
status?: Schema$Status;
}
/**
* A person's read-only cover photo. A large image shown on the
* person's profile page that represents who they are or what they care
* about.
*/
interface Schema$CoverPhoto {
/**
* True if the cover photo is the default cover photo; false if the cover
* photo is a user-provided cover photo.
*/
default?: boolean;
/**
* Metadata about the cover photo.
*/
metadata?: Schema$FieldMetadata;
/**
* The URL of the cover photo.
*/
url?: string;
}
/**
* A request to create a new contact group.
*/
interface Schema$CreateContactGroupRequest {
/**
* The contact group to create.
*/
contactGroup?: Schema$ContactGroup;
}
/**
* Represents a whole calendar date, for example a date of birth. The time of
* day and time zone are either specified elsewhere or are not significant.
* The date is relative to the [Proleptic Gregorian
* Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The
* day may be 0 to represent a year and month where the day is not
* significant. The year may be 0 to represent a month and day independent of
* year; for example, anniversary date.
*/
interface Schema$Date {
/**
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0
* if specifying a year by itself or a year and month where the day is not
* significant.
*/
day?: number;
/**
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a
* month and day.
*/
month?: number;
/**
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without a
* year.
*/
year?: number;
}
/**
* A Google Apps Domain membership.
*/
interface Schema$DomainMembership {
/**
* True if the person is in the viewer's Google Apps domain.
*/
inViewerDomain?: boolean;
}
/**
* A person's email address.
*/
interface Schema$EmailAddress {
/**
* The display name of the email.
*/
displayName?: string;
/**
* The read-only type of the email address translated and formatted in the
* viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string;
/**
* Metadata about the email address.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the email address. The type can be custom or one of these
* predefined values: * `home` * `work` * `other`
*/
type?: string;
/**
* The email address.
*/
value?: string;
}
/**
* 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 `{}`.
*/
interface Schema$Empty {
}
/**
* An event related to the person.
*/
interface Schema$Event {
/**
* The date of the event.
*/
date?: Schema$Date;
/**
* The read-only type of the event translated and formatted in the
* viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string;
/**
* Metadata about the event.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the event. The type can be custom or one of these predefined
* values: * `anniversary` * `other`
*/
type?: string;
}
/**
* Metadata about a field.
*/
interface Schema$FieldMetadata {
/**
* True if the field is the primary field; false if the field is a secondary
* field.
*/
primary?: boolean;
/**
* The source of the field.
*/
source?: Schema$Source;
/**
* True if the field is verified; false if the field is unverified. A
* verified field is typically a name, email address, phone number, or
* website that has been confirmed to be owned by the person.
*/
verified?: boolean;
}
/**
* A person's gender.
*/
interface Schema$Gender {
/**
* The read-only value of the gender translated and formatted in the
* viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedValue?: string;
/**
* Metadata about the gender.
*/
metadata?: Schema$FieldMetadata;
/**
* The gender for the person. The gender can be custom or one of these
* predefined values: * `male` * `female` * `other` * `unknown`
*/
value?: string;
}
interface Schema$GetPeopleResponse {
/**
* The response for each requested resource name.
*/
responses?: Schema$PersonResponse[];
}
/**
* A person's instant messaging client.
*/
interface Schema$ImClient {
/**
* The read-only protocol of the IM client formatted in the viewer's
* account locale or the `Accept-Language` HTTP header locale.
*/
formattedProtocol?: string;
/**
* The read-only type of the IM client translated and formatted in the
* viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string;
/**
* Metadata about the IM client.
*/
metadata?: Schema$FieldMetadata;
/**
* The protocol of the IM client. The protocol can be custom or one of these
* predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` *
* `googleTalk` * `icq` * `jabber` * `netMeeting`
*/
protocol?: string;
/**
* The type of the IM client. The type can be custom or one of these
* predefined values: * `home` * `work` * `other`
*/
type?: string;
/**
* The user name used in the IM client.
*/
username?: string;
}
/**
* One of the person's interests.
*/
interface Schema$Interest {
/**
* Metadata about the interest.
*/
metadata?: Schema$FieldMetadata;
/**
* The interest; for example, `stargazing`.
*/
value?: string;
}
interface Schema$ListConnectionsResponse {
/**
* The list of people that the requestor is connected to.
*/
connections?: Schema$Person[];
/**
* The token that can be used to retrieve the next page of results.
*/
nextPageToken?: string;
/**
* The token that can be used to retrieve changes since the last request.
*/
nextSyncToken?: string;
/**
* The total number of items in the list without pagination.
*/
totalItems?: number;
/**
* **DEPRECATED** (Please use totalItems) The total number of people in the
* list without pagination.
*/
totalPeople?: number;
}
/**
* The response to a list contact groups request.
*/
interface Schema$ListContactGroupsResponse {
/**
* The list of contact groups. Members of the contact groups are not
* populated.
*/
contactGroups?: Schema$ContactGroup[];
/**
* The token that can be used to retrieve the next page of results.
*/
nextPageToken?: string;
/**
* The token that can be used to retrieve changes since the last request.
*/
nextSyncToken?: string;
/**
* The total number of items in the list without pagination.
*/
totalItems?: number;
}
/**
* A person's locale preference.
*/
interface Schema$Locale {
/**
* Metadata about the locale.
*/
metadata?: Schema$FieldMetadata;
/**
* The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language
* tag representing the locale.
*/
value?: string;
}
/**
* A person's read-only membership in a group.
*/
interface Schema$Membership {
/**
* The contact group membership.
*/
contactGroupMembership?: Schema$ContactGroupMembership;
/**
* The domain membership.
*/
domainMembership?: Schema$DomainMembership;
/**
* Metadata about the membership.
*/
metadata?: Schema$FieldMetadata;
}
/**
* A request to modify an existing contact group's members. Contacts can
* be removed from any group but they can only be added to a user group or
* myContacts or starred system groups.
*/
interface Schema$ModifyContactGroupMembersRequest {
/**
* The resource names of the contact people to add in the form of in the
* form `people/`<var>person_id</var>.
*/
resourceNamesToAdd?: string[];
/**
* The resource names of the contact people to remove in the form of in the
* form of `people/`<var>person_id</var>.
*/
resourceNamesToRemove?: string[];
}
/**
* The response to a modify contact group members request.
*/
interface Schema$ModifyContactGroupMembersResponse {
/**
* The contact people resource names that were not found.
*/
notFoundResourceNames?: string[];
}
/**
* A person's name. If the name is a mononym, the family name is empty.
*/
interface Schema$Name {
/**
* The read-only display name formatted according to the locale specified by
* the viewer's account or the `Accept-Language` HTTP header.
*/
displayName?: string;
/**
* The read-only display name with the last name first formatted according
* to the locale specified by the viewer's account or the
* `Accept-Language` HTTP header.
*/
displayNameLastFirst?: string;
/**
* The family name.
*/
familyName?: string;
/**
* The given name.
*/
givenName?: string;
/**
* The honorific prefixes, such as `Mrs.` or `Dr.`
*/
honorificPrefix?: string;
/**
* The honorific suffixes, such as `Jr.`
*/
honorificSuffix?: string;
/**
* Metadata about the name.
*/
metadata?: Schema$FieldMetadata;
/**
* The middle name(s).
*/
middleName?: string;
/**
* The family name spelled as it sounds.
*/
phoneticFamilyName?: string;
/**
* The full name spelled as it sounds.
*/
phoneticFullName?: string;
/**
* The given name spelled as it sounds.
*/
phoneticGivenName?: string;
/**
* The honorific prefixes spelled as they sound.
*/
phoneticHonorificPrefix?: string;
/**
* The honorific suffixes spelled as they sound.
*/
phoneticHonorificSuffix?: string;
/**
* The middle name(s) spelled as they sound.
*/
phoneticMiddleName?: string;
}
/**
* A person's nickname.
*/
interface Schema$Nickname {
/**
* Metadata about the nickname.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the nickname.
*/
type?: string;
/**
* The nickname.
*/
value?: string;
}
/**
* A person's occupation.
*/
interface Schema$Occupation {
/**
* Metadata about the occupation.
*/
metadata?: Schema$FieldMetadata;
/**
* The occupation; for example, `carpenter`.
*/
value?: string;
}
/**
* A person's past or current organization. Overlapping date ranges are
* permitted.
*/
interface Schema$Organization {
/**
* True if the organization is the person's current organization; false
* if the organization is a past organization.
*/
current?: boolean;
/**
* The person's department at the organization.
*/
department?: string;
/**
* The domain name associated with the organization; for example,
* `google.com`.
*/
domain?: string;
/**
* The end date when the person left the organization.
*/
endDate?: Schema$Date;
/**
* The read-only type of the organization translated and formatted in the
* viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string;
/**
* The person's job description at the organization.
*/
jobDescription?: string;
/**
* The location of the organization office the person works at.
*/
location?: string;
/**
* Metadata about the organization.
*/
metadata?: Schema$FieldMetadata;
/**
* The name of the organization.
*/
name?: string;
/**
* The phonetic name of the organization.
*/
phoneticName?: string;
/**
* The start date when the person joined the organization.
*/
startDate?: Schema$Date;
/**
* The symbol associated with the organization; for example, a stock ticker
* symbol, abbreviation, or acronym.
*/
symbol?: string;
/**
* The person's job title at the organization.
*/
title?: string;
/**
* The type of the organization. The type can be custom or one of these
* predefined values: * `work` * `school`
*/
type?: string;
}
/**
* Information about a person merged from various data sources such as the
* authenticated user's contacts and profile data. Most fields can have
* multiple items. The items in a field have no guaranteed order, but each
* non-empty field is guaranteed to have exactly one field with
* `metadata.primary` set to true.
*/
interface Schema$Person {
/**
* The person's street addresses.
*/
addresses?: Schema$Address[];
/**
* **DEPRECATED** (Please use `person.ageRanges` instead)** The
* person's read-only age range.
*/
ageRange?: string;
/**
* The person's read-only age ranges.
*/
ageRanges?: Schema$AgeRangeType[];
/**
* The person's biographies.
*/
biographies?: Schema$Biography[];
/**
* The person's birthdays.
*/
birthdays?: Schema$Birthday[];
/**
* The person's bragging rights.
*/
braggingRights?: Schema$BraggingRights[];
/**
* The person's read-only cover photos.
*/
coverPhotos?: Schema$CoverPhoto[];
/**
* The person's email addresses.
*/
emailAddresses?: Schema$EmailAddress[];
/**
* The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
* resource. Used for web cache validation.
*/
etag?: string;
/**
* The person's events.
*/
events?: Schema$Event[];
/**
* The person's genders.
*/
genders?: Schema$Gender[];
/**
* The person's instant messaging clients.
*/
imClients?: Schema$ImClient[];
/**
* The person's interests.
*/
interests?: Schema$Interest[];
/**
* The person's locale preferences.
*/
locales?: Schema$Locale[];
/**
* The person's read-only group memberships.
*/
memberships?: Schema$Membership[];
/**
* Read-only metadata about the person.
*/
metadata?: Schema$PersonMetadata;
/**
* The person's names.
*/
names?: Schema$Name[];
/**
* The person's nicknames.
*/
nicknames?: Schema$Nickname[];
/**
* The person's occupations.
*/
occupations?: Schema$Occupation[];
/**
* The person's past or current organizations.
*/
organizations?: Schema$Organization[];
/**
* The person's phone numbers.
*/
phoneNumbers?: Schema$PhoneNumber[];
/**
* The person's read-only photos.
*/
photos?: Schema$Photo[];
/**
* The person's relations.
*/
relations?: Schema$Relation[];
/**
* The person's read-only relationship interests.
*/
relationshipInterests?: Schema$RelationshipInterest[];
/**
* The person's read-only relationship statuses.
*/
relationshipStatuses?: Schema$RelationshipStatus[];
/**
* The person's residences.
*/
residences?: Schema$Residence[];
/**
* The resource name for the person, assigned by the server. An ASCII string
* with a max length of 27 characters, in the form of
* `people/`<var>person_id</var>.
*/
resourceName?: string;
/**
* The person's SIP addresses.
*/
sipAddresses?: Schema$SipAddress[];
/**
* The person's skills.
*/
skills?: Schema$Skill[];
/**
* The person's read-only taglines.
*/
taglines?: Schema$Tagline[];
/**
* The person's associated URLs.
*/
urls?: Schema$Url[];
/**
* The person's user defined data.
*/
userDefined?: Schema$UserDefined[];
}
/**
* The read-only metadata about a person.
*/
interface Schema$PersonMetadata {
/**
* True if the person resource has been deleted. Populated only for
* [`connections.list`](/people/api/rest/v1/people.connections/list)
* requests that include a sync token.
*/
deleted?: boolean;
/**
* Resource names of people linked to this resource.
*/
linkedPeopleResourceNames?: string[];
/**
* **DEPRECATED** (Please use
* `person.metadata.sources.profileMetadata.objectType` instead) The type
* of the person object.
*/
objectType?: string;
/**
* Any former resource names this person has had. Populated only for
* [`connections.list`](/people/api/rest/v1/people.connections/list)
* requests that include a sync token. The resource name may change when
* adding or removing fields that link a contact and profile such as a
* verified email, verified phone number, or profile URL.
*/
previousResourceNames?: string[];
/**
* The sources of data for the person.
*/
sources?: Schema$Source[];
}
/**
* The response for a single person
*/
interface Schema$PersonResponse {
/**
* **DEPRECATED** (Please use status instead) [HTTP 1.1 status code]
* (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
*/
httpStatusCode?: number;
/**
* The person.
*/
person?: Schema$Person;
/**
* The original requested resource name. May be different than the resource
* name on the returned person. The resource name can change when adding or
* removing fields that link a contact and profile such as a verified email,
* verified phone number, or a profile URL.
*/
requestedResourceName?: string;
/**
* The status of the response.
*/
status?: Schema$Status;
}
/**
* A person's phone number.
*/
interface Schema$PhoneNumber {
/**
* The read-only canonicalized [ITU-T
* E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
* form of the phone number.
*/
canonicalForm?: string;
/**
* The read-only type of the phone number translated and formatted in the
* viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string;
/**
* Metadata about the phone number.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the phone number. The type can be custom or one of these
* predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax`
* * `otherFax` * `pager` * `workMobile` * `workPager` * `main` *
* `googleVoice` * `other`
*/
type?: string;
/**
* The phone number.
*/
value?: string;
}
/**
* A person's read-only photo. A picture shown next to the person's
* name to help others recognize the person.
*/
interface Schema$Photo {
/**
* True if the photo is a default photo; false if the photo is a
* user-provided photo.
*/
default?: boolean;
/**
* Metadata about the photo.
*/
metadata?: Schema$FieldMetadata;
/**
* The URL of the photo. You can change the desired size by appending a
* query parameter `sz=`<var>size</var> at the end of the url.
* Example:
* `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
*/
url?: string;
}
/**
* The read-only metadata about a profile.
*/
interface Schema$ProfileMetadata {
/**
* The profile object type.
*/
objectType?: string;
/**
* The user types.
*/
userTypes?: string[];
}
/**
* A person's relation to another person.
*/
interface Schema$Relation {
/**
* The type of the relation translated and formatted in the viewer's
* account locale or the locale specified in the Accept-Language HTTP
* header.
*/
formattedType?: string;
/**
* Metadata about the relation.
*/
metadata?: Schema$FieldMetadata;
/**
* The name of the other person this relation refers to.
*/
person?: string;
/**
* The person's relation to the other person. The type can be custom or
* one of these predefined values: * `spouse` * `child` * `mother` *
* `father` * `parent` * `brother` * `sister` * `friend` * `relative` *
* `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
*/
type?: string;
}
/**
* A person's read-only relationship interest .
*/
interface Schema$RelationshipInterest {
/**
* The value of the relationship interest translated and formatted in the
* viewer's account locale or the locale specified in the
* Accept-Language HTTP header.
*/
formattedValue?: string;
/**
* Metadata about the relationship interest.
*/
metadata?: Schema$FieldMetadata;
/**
* The kind of relationship the person is looking for. The value can be
* custom or one of these predefined values: * `friend` * `date` *
* `relationship` * `networking`
*/
value?: string;
}
/**
* A person's read-only relationship status.
*/
interface Schema$RelationshipStatus {
/**
* The read-only value of the relationship status translated and formatted
* in the viewer's account locale or the `Accept-Language` HTTP header
* locale.
*/
formattedValue?: string;
/**
* Metadata about the relationship status.
*/
metadata?: Schema$FieldMetadata;
/**
* The relationship status. The value can be custom or one of these
* predefined values: * `single` * `inARelationship` * `engaged` *
* `married` * `itsComplicated` * `openRelationship` * `widowed` *
* `inDomesticPartnership` * `inCivilUnion`
*/
value?: string;
}
/**
* A person's past or current residence.
*/
interface Schema$Residence {
/**
* True if the residence is the person's current residence; false if the
* residence is a past residence.
*/
current?: boolean;
/**
* Metadata about the residence.
*/
metadata?: Schema$FieldMetadata;
/**
* The address of the residence.
*/
value?: string;
}
/**
* A person's SIP address. Session Initial Protocol addresses are used for
* VoIP communications to make voice or video calls over the internet.
*/
interface Schema$SipAddress {
/**
* The read-only type of the SIP address translated and formatted in the
* viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string;
/**
* Metadata about the SIP address.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the SIP address. The type can be custom or or one of these
* predefined values: * `home` * `work` * `mobile` * `other`
*/
type?: string;
/**
* The SIP address in the [RFC
* 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
* format.
*/
value?: string;
}
/**
* A skill that the person has.
*/
interface Schema$Skill {
/**
* Metadata about the skill.
*/
metadata?: Schema$FieldMetadata;
/**
* The skill; for example, `underwater basket weaving`.
*/
value?: string;
}
/**
* The source of a field.
*/
interface Schema$Source {
/**
* **Only populated in `person.metadata.sources`.** The [HTTP entity
* tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web
* cache validation.
*/
etag?: string;
/**
* The unique identifier within the source type generated by the server.
*/
id?: string;
/**
* **Only populated in `person.metadata.sources`.** Metadata about a source
* of type PROFILE.
*/
profileMetadata?: Schema$ProfileMetadata;
/**
* The source type.
*/
type?: string;
/**
* **Only populated in `person.metadata.sources`.** Last update timestamp
* of this source.
*/
updateTime?: string;
}
/**
* 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). The error model is designed to be:
* - Simple to use and understand for most users - Flexible enough to meet
* unexpected needs # Overview The `Status` message contains three pieces of
* data: error code, error message, and error details. The error code should
* be an enum value of google.rpc.Code, but it may accept additional error
* codes if needed. The error message should be a developer-facing English
* message that helps developers *understand* and *resolve* the error. If a
* localized user-facing error message is needed, put the localized message in
* the error details or localize it in the client. The optional error details
* may contain arbitrary information about the error. There is a predefined
* set of error detail types in the package `google.rpc` that can be used for
* common error conditions. # Language mapping The `Status` message is the
* logical representation of the error model, but it is not necessarily the
* actual wire format. When the `Status` message is exposed in different
* client libraries and different wire protocols, it can be mapped
* differently. For example, it will likely be mapped to some exceptions in
* Java, but more likely mapped to some error codes in C. # Other uses The
* error model and the `Status` message can be used in a variety of
* environments, either with or without APIs, to provide a consistent
* developer experience across different environments. Example uses of this
* error model include: - Partial errors. If a service needs to return
* partial errors to the client, it may embed the `Status` in the normal
* response to indicate the partial errors. - Workflow errors. A typical
* workflow has multiple steps. Each step may have a `Status` message for
* error reporting. - Batch operations. If a client uses batch request and
* batch response, the `Status` message should be used directly inside
* batch response, one for each error sub-response. - Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should be represented directly
* using the `Status` message. - Logging. If some API errors are stored in
* logs, the message `Status` could be used directly after any stripping
* needed for security/privacy reasons.
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* 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;
}>;
/**
* 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;
}
/**
* A read-only brief one-line description of the person.
*/
interface Schema$Tagline {
/**
* Metadata about the tagline.
*/
metadata?: Schema$FieldMetadata;
/**
* The tagline.
*/
value?: string;
}
/**
* A request to update an existing user contact group. All updated fields will
* be replaced.
*/
interface Schema$UpdateContactGroupRequest {
/**
* The contact group to update.
*/
contactGroup?: Schema$ContactGroup;
}
/**
* A person's associated URLs.
*/
interface Schema$Url {
/**
* The read-only type of the URL translated and formatted in the
* viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string;
/**
* Metadata about the URL.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the URL. The type can be custom or one of these predefined
* values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` *
* `reservations` * `appInstallPage`: website for a Google+ application. *
* `other`
*/
type?: string;
/**
* The URL.
*/
value?: string;
}
/**
* Arbitrary user data that is populated by the end users.
*/
interface Schema$UserDefined {
/**
* The end user specified key of the user defined data.
*/
key?: string;
/**
* Metadata about the user defined data.
*/
metadata?: Schema$FieldMetadata;
/**
* The end user specified value of the user defined data.
*/
value?: string;
}
class Resource$Contactgroups {
context: APIRequestContext;
members: Resource$Contactgroups$Members;
constructor(context: APIRequestContext);
/**
* people.contactGroups.batchGet
* @desc Get a list of contact groups owned by the authenticated user by
* specifying a list of contact group resource names.
* @alias people.contactGroups.batchGet
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxMembers Specifies the maximum number of members to return for each group.
* @param {string=} params.resourceNames The resource names of the contact groups to get.
* @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
*/
batchGet(params?: Params$Resource$Contactgroups$Batchget, options?: MethodOptions): GaxiosPromise<Schema$BatchGetContactGroupsResponse>;
batchGet(params: Params$Resource$Contactgroups$Batchget, options: MethodOptions | BodyResponseCallback<Schema$BatchGetContactGroupsResponse>, callback: BodyResponseCallback<Schema$BatchGetContactGroupsResponse>): void;
batchGet(params: Params$Resource$Contactgroups$Batchget, callback: BodyResponseCallback<Schema$BatchGetContactGroupsResponse>): void;
batchGet(callback: BodyResponseCallback<Schema$BatchGetContactGroupsResponse>): void;
/**
* people.contactGroups.create
* @desc Create a new contact group owned by the authenticated user.
* @alias people.contactGroups.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().CreateContactGroupRequest} 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$Contactgroups$Create, options?: MethodOptions): GaxiosPromise<Schema$ContactGroup>;
create(params: Params$Resource$Contactgroups$Create, options: MethodOptions | BodyResponseCallback<Schema$ContactGroup>, callback: BodyResponseCallback<Schema$ContactGroup>): void;
create(params: Params$Resource$Contactgroups$Create, callback: BodyResponseCallback<Schema$ContactGroup>): void;
create(callback: BodyResponseCallback<Schema$ContactGroup>): void;
/**
* people.contactGroups.delete
* @desc Delete an existing contact group owned by the authenticated user by
* specifying a contact group resource name.
* @alias people.contactGroups.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.deleteContacts Set to true to also delete the contacts in the specified group.
* @param {string} params.resourceName The resource name of the contact group to delete.
* @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$Contactgroups$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Contactgroups$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Contactgroups$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* people.contactGroups.get
* @desc Get a specific contact group owned by the authenticated user by
* specifying a contact group resource name.
* @alias people.contactGroups.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxMembers Specifies the maximum number of members to return.
* @param {string} params.resourceName The resource name of the contact group to get.
* @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$Contactgroups$Get, options?: MethodOptions): GaxiosPromise<Schema$ContactGroup>;
get(params: Params$Resource$Contactgroups$Get, options: MethodOptions | BodyResponseCallback<Schema$ContactGroup>, callback: BodyResponseCallback<Schema$ContactGroup>): void;
get(params: Params$Resource$Contactgroups$Get, callback: BodyResponseCallback<Schema$ContactGroup>): void;
get(callback: BodyResponseCallback<Schema$ContactGroup>): void;
/**
* people.contactGroups.list
* @desc List all contact groups owned by the authenticated user. Members of
* the contact groups are not populated.
* @alias people.contactGroups.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of resources to return.
* @param {string=} params.pageToken The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.
* @param {string=} params.syncToken A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.
* @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$Contactgroups$List, options?: MethodOptions): GaxiosPromise<Schema$ListContactGroupsResponse>;
list(params: Params$Resource$Contactgroups$List, options: MethodOptions | BodyResponseCallback<Schema$ListContactGroupsResponse>, callback: BodyResponseCallback<Schema$ListContactGroupsResponse>): void;
list(params: Params$Resource$Contactgroups$List, callback: BodyResponseCallback<Schema$ListContactGroupsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListContactGroupsResponse>): void;
/**
* people.contactGroups.update
* @desc Update the name of an existing contact group owned by the
* authenticated user.
* @alias people.contactGroups.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resourceName The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`<var>contact_group_id</var>.
* @param {().UpdateContactGroupRequest} 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
*/
update(params?: Params$Resource$Contactgroups$Update, options?: MethodOptions): GaxiosPromise<Schema$ContactGroup>;
update(params: Params$Resource$Contactgroups$Update, options: MethodOptions | BodyResponseCallback<Schema$ContactGroup>, callback: BodyResponseCallback<Schema$ContactGroup>): void;
update(params: Params$Resource$Contactgroups$Update, callback: BodyResponseCallback<Schema$ContactGroup>): void;
update(callback: BodyResponseCallback<Schema$ContactGroup>): void;
}
interface Params$Resource$Contactgroups$Batchget extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Specifies the maximum number of members to return for each group.
*/
maxMembers?: number;
/**
* The resource names of the contact groups to get.
*/
resourceNames?: string[];
}
interface Params$Resource$Contactgroups$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$CreateContactGroupRequest;
}
interface Params$Resource$Contactgroups$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Set to true to also delete the contacts in the specified group.
*/
deleteContacts?: boolean;
/**
* The resource name of the contact group to delete.
*/
resourceName?: string;
}
interface Params$Resource$Contactgroups$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Specifies the maximum number of members to return.
*/
maxMembers?: number;
/**
* The resource name of the contact group to get.
*/
resourceName?: string;
}
interface Params$Resource$Contactgroups$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of resources to return.
*/
pageSize?: number;
/**
* The next_page_token value returned from a previous call to
* [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the
* next page of resources.
*/
pageToken?: string;
/**
* A sync token, returned by a previous call to `contactgroups.list`. Only
* resources changed since the sync token was created will be returned.
*/
syncToken?: string;
}
interface Params$Resource$Contactgroups$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name for the contact group, assigned by the server. An ASCII
* string, in the form of `contactGroups/`<var>contact_group_id</var>.
*/
resourceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateContactGroupRequest;
}
class Resource$Contactgroups$Members {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* people.contactGroups.members.modify
* @desc Modify the members of a contact group owned by the authenticated
* user. <br> The only system contact groups that can have members added are
* `contactGroups/myContacts` and `contactGroups/starred`. Other system
* contact groups are deprecated and can only have contacts removed.
* @alias people.contactGroups.members.modify
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resourceName The resource name of the contact group to modify.
* @param {().ModifyContactGroupMembersRequest} 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
*/
modify(params?: Params$Resource$Contactgroups$Members$Modify, options?: MethodOptions): GaxiosPromise<Schema$ModifyContactGroupMembersResponse>;
modify(params: Params$Resource$Contactgroups$Members$Modify, options: MethodOptions | BodyResponseCallback<Schema$ModifyContactGroupMembersResponse>, callback: BodyResponseCallback<Schema$ModifyContactGroupMembersResponse>): void;
modify(params: Params$Resource$Contactgroups$Members$Modify, callback: BodyResponseCallback<Schema$ModifyContactGroupMembersResponse>): void;
modify(callback: BodyResponseCallback<Schema$ModifyContactGroupMembersResponse>): void;
}
interface Params$Resource$Contactgroups$Members$Modify extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the contact group to modify.
*/
resourceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ModifyContactGroupMembersRequest;
}
class Resource$People {
context: APIRequestContext;
connections: Resource$People$Connections;
constructor(context: APIRequestContext);
/**
* people.people.createContact
* @desc Create a new contact and return the person resource for that
* contact.
* @alias people.people.createContact
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.parent The resource name of the owning person resource.
* @param {().Person} 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
*/
createContact(params?: Params$Resource$People$Createcontact, options?: MethodOptions): GaxiosPromise<Schema$Person>;
createContact(params: Params$Resource$People$Createcontact, options: MethodOptions | BodyResponseCallback<Schema$Person>, callback: BodyResponseCallback<Schema$Person>): void;
createContact(params: Params$Resource$People$Createcontact, callback: BodyResponseCallback<Schema$Person>): void;
createContact(callback: BodyResponseCallback<Schema$Person>): void;
/**
* people.people.deleteContact
* @desc Delete a contact person. Any non-contact data will not be deleted.
* @alias people.people.deleteContact
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resourceName The resource name of the contact to delete.
* @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
*/
deleteContact(params?: Params$Resource$People$Deletecontact, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
deleteContact(params: Params$Resource$People$Deletecontact, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
deleteContact(params: Params$Resource$People$Deletecontact, callback: BodyResponseCallback<Schema$Empty>): void;
deleteContact(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* people.people.get
* @desc Provides information about a person by specifying a resource name.
* Use `people/me` to indicate the authenticated user. <br> The request
* throws a 400 error if 'personFields' is not specified.
* @alias people.people.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.personFields **Required.** A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined
* @param {string=} params.requestMask.includeField **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
* @param {string} params.resourceName The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`<var>account_id</var>. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list).
* @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$People$Get, options?: MethodOptions): GaxiosPromise<Schema$Person>;
get(params: Params$Resource$People$Get, options: MethodOptions | BodyResponseCallback<Schema$Person>, callback: BodyResponseCallback<Schema$Person>): void;
get(params: Params$Resource$People$Get, callback: BodyResponseCallback<Schema$Person>): void;
get(callback: BodyResponseCallback<Schema$Person>): void;
/**
* people.people.getBatchGet
* @desc Provides information about a list of specific people by specifying
* a list of requested resource names. Use `people/me` to indicate the
* authenticated user. <br> The request throws a 400 error if 'personFields'
* is not specified.
* @alias people.people.getBatchGet
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.personFields **Required.** A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined
* @param {string=} params.requestMask.includeField **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
* @param {string=} params.resourceNames The resource names of the people to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`<var>account_id</var>. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request.
* @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
*/
getBatchGet(params?: Params$Resource$People$Getbatchget, options?: MethodOptions): GaxiosPromise<Schema$GetPeopleResponse>;
getBatchGet(params: Params$Resource$People$Getbatchget, options: MethodOptions | BodyResponseCallback<Schema$GetPeopleResponse>, callback: BodyResponseCallback<Schema$GetPeopleResponse>): void;
getBatchGet(params: Params$Resource$People$Getbatchget, callback: BodyResponseCallback<Schema$GetPeopleResponse>): void;
getBatchGet(callback: BodyResponseCallback<Schema$GetPeopleResponse>): void;
/**
* people.people.updateContact
* @desc Update contact data for an existing contact person. Any non-contact
* data will not be modified. The request throws a 400 error if
* `updatePersonFields` is not specified. <br> The request throws a 400
* error if `person.metadata.sources` is not specified for the contact to be
* updated. <br> The request throws a 412 error if
* `person.metadata.sources.etag` is different than the contact's etag,
* which indicates the contact has changed since its data was read. Clients
* should get the latest person and re-apply their updates to the latest
* person.
* @alias people.people.updateContact
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resourceName The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/`<var>person_id</var>.
* @param {string=} params.updatePersonFields **Required.** A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * emailAddresses * events * genders * imClients * interests * locales * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined
* @param {().Person} 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
*/
updateContact(params?: Params$Resource$People$Updatecontact, options?: MethodOptions): GaxiosPromise<Schema$Person>;
updateContact(params: Params$Resource$People$Updatecontact, options: MethodOptions | BodyResponseCallback<Schema$Person>, callback: BodyResponseCallback<Schema$Person>): void;
updateContact(params: Params$Resource$People$Updatecontact, callback: BodyResponseCallback<Schema$Person>): void;
updateContact(callback: BodyResponseCallback<Schema$Person>): void;
}
interface Params$Resource$People$Createcontact extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the owning person resource.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Person;
}
interface Params$Resource$People$Deletecontact extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the contact to delete.
*/
resourceName?: string;
}
interface Params$Resource$People$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* **Required.** A field mask to restrict which fields on the person are
* returned. Multiple fields can be specified by separating them with
* commas. Valid values are: * addresses * ageRanges * biographies *
* birthdays * braggingRights * coverPhotos * emailAddresses * events *
* genders * imClients * interests * locales * memberships * metadata *
* names * nicknames * occupations * organizations * phoneNumbers * photos *
* relations * relationshipInterests * relationshipStatuses * residences *
* sipAddresses * skills * taglines * urls * userDefined
*/
personFields?: string;
/**
* **Required.** Comma-separated list of person fields to be included in the
* response. Each path should start with `person.`: for example,
* `person.names` or `person.photos`.
*/
'requestMask.includeField'?: string;
/**
* The resource name of the person to provide information about. - To get
* information about the authenticated user, specify `people/me`. - To get
* information about a google account, specify
* `people/`<var>account_id</var>. - To get information about a contact,
* specify the resource name that identifies the contact as returned by
* [`people.connections.list`](/people/api/rest/v1/people.connections/list).
*/
resourceName?: string;
}
interface Params$Resource$People$Getbatchget extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* **Required.** A field mask to restrict which fields on each person are
* returned. Multiple fields can be specified by separating them with
* commas. Valid values are: * addresses * ageRanges * biographies *
* birthdays * braggingRights * coverPhotos * emailAddresses * events *
* genders * imClients * interests * locales * memberships * metadata *
* names * nicknames * occupations * organizations * phoneNumbers * photos *
* relations * relationshipInterests * relationshipStatuses * residences *
* sipAddresses * skills * taglines * urls * userDefined
*/
personFields?: string;
/**
* **Required.** Comma-separated list of person fields to be included in the
* response. Each path should start with `person.`: for example,
* `person.names` or `person.photos`.
*/
'requestMask.includeField'?: string;
/**
* The resource names of the people to provide information about. - To get
* information about the authenticated user, specify `people/me`. - To get
* information about a google account, specify
* `people/`<var>account_id</var>. - To get information about a contact,
* specify the resource name that identifies the contact as returned by
* [`people.connections.list`](/people/api/rest/v1/people.connections/list).
* You can include up to 50 resource names in one request.
*/
resourceNames?: string[];
}
interface Params$Resource$People$Updatecontact extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name for the person, assigned by the server. An ASCII string
* with a max length of 27 characters, in the form of
* `people/`<var>person_id</var>.
*/
resourceName?: string;
/**
* **Required.** A field mask to restrict which fields on the person are
* updated. Multiple fields can be specified by separating them with commas.
* All updated fields will be replaced. Valid values are: * addresses *
* biographies * birthdays * emailAddresses * events * genders * imClients *
* interests * locales * names * nicknames * occupations * organizations *
* phoneNumbers * relations * residences * sipAddresses * urls * userDefined
*/
updatePersonFields?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Person;
}
class Resource$People$Connections {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* people.people.connections.list
* @desc Provides a list of the authenticated user's contacts merged with
* any connected profiles. <br> The request throws a 400 error if
* 'personFields' is not specified.
* @alias people.people.connections.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100.
* @param {string=} params.pageToken The token of the page to be returned.
* @param {string=} params.personFields **Required.** A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined
* @param {string=} params.requestMask.includeField **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
* @param {boolean=} params.requestSyncToken Whether the response should include a sync token, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit.
* @param {string} params.resourceName The resource name to return connections for. Only `people/me` is valid.
* @param {string=} params.sortOrder The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.
* @param {string=} params.syncToken A sync token returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned. Sync requests that specify `sync_token` have an additional rate limit.
* @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$People$Connections$List, options?: MethodOptions): GaxiosPromise<Schema$ListConnectionsResponse>;
list(params: Params$Resource$People$Connections$List, options: MethodOptions | BodyResponseCallback<Schema$ListConnectionsResponse>, callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
list(params: Params$Resource$People$Connections$List, callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
}
interface Params$Resource$People$Connections$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The number of connections to include in the response. Valid values are
* between 1 and 2000, inclusive. Defaults to 100.
*/
pageSize?: number;
/**
* The token of the page to be returned.
*/
pageToken?: string;
/**
* **Required.** A field mask to restrict which fields on each person are
* returned. Multiple fields can be specified by separating them with
* commas. Valid values are: * addresses * ageRanges * biographies *
* birthdays * braggingRights * coverPhotos * emailAddresses * events *
* genders * imClients * interests * locales * memberships * metadata *
* names * nicknames * occupations * organizations * phoneNumbers * photos *
* relations * relationshipInterests * relationshipStatuses * residences *
* sipAddresses * skills * taglines * urls * userDefined
*/
personFields?: string;
/**
* **Required.** Comma-separated list of person fields to be included in the
* response. Each path should start with `person.`: for example,
* `person.names` or `person.photos`.
*/
'requestMask.includeField'?: string;
/**
* Whether the response should include a sync token, which can be used to
* get all changes since the last request. For subsequent sync requests use
* the `sync_token` param instead. Initial sync requests that specify
* `request_sync_token` have an additional rate limit.
*/
requestSyncToken?: boolean;
/**
* The resource name to return connections for. Only `people/me` is valid.
*/
resourceName?: string;
/**
* The order in which the connections should be sorted. Defaults to
* `LAST_MODIFIED_ASCENDING`.
*/
sortOrder?: string;
/**
* A sync token returned by a previous call to `people.connections.list`.
* Only resources changed since the sync token was created will be returned.
* Sync requests that specify `sync_token` have an additional rate limit.
*/
syncToken?: string;
}
}