v1.d.ts
17.6 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
/**
* 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 groupssettings_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: 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;
/**
* An opaque string that represents a user for quota purposes. Must not
* exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Groups Settings API
*
* Manages permission levels and related settings of a group.
*
* @example
* const {google} = require('googleapis');
* const groupssettings = google.groupssettings('v1');
*
* @namespace groupssettings
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Groupssettings
*/
class Groupssettings {
context: APIRequestContext;
groups: Resource$Groups;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* JSON template for Group resource
*/
interface Schema$Groups {
/**
* Are external members allowed to join the group.
*/
allowExternalMembers?: string;
/**
* Is google allowed to contact admins.
*/
allowGoogleCommunication?: string;
/**
* If posting from web is allowed.
*/
allowWebPosting?: string;
/**
* If the group is archive only
*/
archiveOnly?: string;
/**
* Custom footer text.
*/
customFooterText?: string;
/**
* Default email to which reply to any message should go.
*/
customReplyTo?: string;
/**
* If any of the settings that will be merged have custom roles which is
* anything other than owners, managers, or group scopes.
*/
customRolesEnabledForSettingsToBeMerged?: string;
/**
* Default message deny notification message
*/
defaultMessageDenyNotificationText?: string;
/**
* Description of the group
*/
description?: string;
/**
* Email id of the group
*/
email?: string;
/**
* If a primary Collab Inbox feature is enabled.
*/
enableCollaborativeInbox?: string;
/**
* If favorite replies should be displayed above other replies.
*/
favoriteRepliesOnTop?: string;
/**
* Whether to include custom footer.
*/
includeCustomFooter?: string;
/**
* If this groups should be included in global address list or not.
*/
includeInGlobalAddressList?: string;
/**
* If the contents of the group are archived.
*/
isArchived?: string;
/**
* The type of the resource.
*/
kind?: string;
/**
* Maximum message size allowed.
*/
maxMessageBytes?: number;
/**
* Can members post using the group email address.
*/
membersCanPostAsTheGroup?: string;
/**
* Default message display font. Possible values are: DEFAULT_FONT
* FIXED_WIDTH_FONT
*/
messageDisplayFont?: string;
/**
* Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES
* MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
*/
messageModerationLevel?: string;
/**
* Name of the Group
*/
name?: string;
/**
* Primary language for the group.
*/
primaryLanguage?: string;
/**
* Whome should the default reply to a message go to. Possible values are:
* REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER
* REPLY_TO_IGNORE REPLY_TO_MANAGERS
*/
replyTo?: string;
/**
* Should the member be notified if his message is denied by owner.
*/
sendMessageDenyNotification?: string;
/**
* Is the group listed in groups directory
*/
showInGroupDirectory?: string;
/**
* Moderation level for messages detected as spam. Possible values are:
* ALLOW MODERATE SILENTLY_MODERATE REJECT
*/
spamModerationLevel?: string;
/**
* Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD
* ALL_OWNERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
*/
whoCanAdd?: string;
/**
* Permission to add references to a topic. Possible values are: NONE
* OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanAddReferences?: string;
/**
* Permission to approve members. Possible values are:
* ALL_OWNERS_CAN_APPROVE ALL_MANAGERS_CAN_APPROVE ALL_MEMBERS_CAN_APPROVE
* NONE_CAN_APPROVE
*/
whoCanApproveMembers?: string;
/**
* Permission to approve pending messages in the moderation queue. Possible
* values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanApproveMessages?: string;
/**
* Permission to assign topics in a forum to another user. Possible values
* are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanAssignTopics?: string;
/**
* Permission for content assistants. Possible values are: Possible values
* are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanAssistContent?: string;
/**
* Permission to ban users. Possible values are: NONE OWNERS_ONLY
* OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanBanUsers?: string;
/**
* Permission to contact owner of the group via web UI. Possible values are:
* ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT
* ALL_MANAGERS_CAN_CONTACT
*/
whoCanContactOwner?: string;
/**
* Permission to delete replies to topics. Possible values are: NONE
* OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanDeleteAnyPost?: string;
/**
* Permission to delete topics. Possible values are: NONE OWNERS_ONLY
* OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanDeleteTopics?: string;
/**
* Permission for who can discover the group. Possible values are:
* ALL_MEMBERS_CAN_DISCOVER ALL_IN_DOMAIN_CAN_DISCOVER ANYONE_CAN_DISCOVER
*/
whoCanDiscoverGroup?: string;
/**
* Permission to enter free form tags for topics in a forum. Possible values
* are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanEnterFreeFormTags?: string;
/**
* Permission to hide posts by reporting them as abuse. Possible values are:
* NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanHideAbuse?: string;
/**
* Permissions to invite members. Possible values are:
* ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE ALL_OWNERS_CAN_INVITE
* NONE_CAN_INVITE
*/
whoCanInvite?: string;
/**
* Permissions to join the group. Possible values are: ANYONE_CAN_JOIN
* ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN
*/
whoCanJoin?: string;
/**
* Permission to leave the group. Possible values are:
* ALL_MANAGERS_CAN_LEAVE ALL_OWNERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE
* NONE_CAN_LEAVE
*/
whoCanLeaveGroup?: string;
/**
* Permission to lock topics. Possible values are: NONE OWNERS_ONLY
* OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanLockTopics?: string;
/**
* Permission to make topics appear at the top of the topic list. Possible
* values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS
* ALL_MEMBERS
*/
whoCanMakeTopicsSticky?: string;
/**
* Permission to mark a topic as a duplicate of another topic. Possible
* values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS
* ALL_MEMBERS
*/
whoCanMarkDuplicate?: string;
/**
* Permission to mark any other user's post as a favorite reply.
* Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS
* ALL_MEMBERS
*/
whoCanMarkFavoriteReplyOnAnyTopic?: string;
/**
* Permission to mark a post for a topic they started as a favorite reply.
* Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS
* ALL_MEMBERS
*/
whoCanMarkFavoriteReplyOnOwnTopic?: string;
/**
* Permission to mark a topic as not needing a response. Possible values
* are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanMarkNoResponseNeeded?: string;
/**
* Permission for content moderation. Possible values are: NONE OWNERS_ONLY
* OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanModerateContent?: string;
/**
* Permission for membership moderation. Possible values are: NONE
* OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanModerateMembers?: string;
/**
* Permission to modify members (change member roles). Possible values are:
* NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanModifyMembers?: string;
/**
* Permission to change tags and categories. Possible values are: NONE
* OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanModifyTagsAndCategories?: string;
/**
* Permission to move topics into the group or forum. Possible values are:
* NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanMoveTopicsIn?: string;
/**
* Permission to move topics out of the group or forum. Possible values are:
* NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanMoveTopicsOut?: string;
/**
* Permission to post announcements, a special topic type. Possible values
* are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanPostAnnouncements?: string;
/**
* Permissions to post messages to the group. Possible values are:
* NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST
* ALL_OWNERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST
*/
whoCanPostMessage?: string;
/**
* Permission to take topics in a forum. Possible values are: NONE
* OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanTakeTopics?: string;
/**
* Permission to unassign any topic in a forum. Possible values are: NONE
* OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanUnassignTopic?: string;
/**
* Permission to unmark any post from a favorite reply. Possible values are:
* NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS
*/
whoCanUnmarkFavoriteReplyOnAnyTopic?: string;
/**
* Permissions to view group. Possible values are: ANYONE_CAN_VIEW
* ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
* ALL_OWNERS_CAN_VIEW
*/
whoCanViewGroup?: string;
/**
* Permissions to view membership. Possible values are:
* ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
* ALL_OWNERS_CAN_VIEW
*/
whoCanViewMembership?: string;
}
class Resource$Groups {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* groupsSettings.groups.get
* @desc Gets one resource by id.
* @alias groupsSettings.groups.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.groupUniqueId The resource 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$Groups$Get, options?: MethodOptions): GaxiosPromise<Schema$Groups>;
get(params: Params$Resource$Groups$Get, options: MethodOptions | BodyResponseCallback<Schema$Groups>, callback: BodyResponseCallback<Schema$Groups>): void;
get(params: Params$Resource$Groups$Get, callback: BodyResponseCallback<Schema$Groups>): void;
get(callback: BodyResponseCallback<Schema$Groups>): void;
/**
* groupsSettings.groups.patch
* @desc Updates an existing resource. This method supports patch semantics.
* @alias groupsSettings.groups.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.groupUniqueId The resource ID
* @param {().Groups} 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$Groups$Patch, options?: MethodOptions): GaxiosPromise<Schema$Groups>;
patch(params: Params$Resource$Groups$Patch, options: MethodOptions | BodyResponseCallback<Schema$Groups>, callback: BodyResponseCallback<Schema$Groups>): void;
patch(params: Params$Resource$Groups$Patch, callback: BodyResponseCallback<Schema$Groups>): void;
patch(callback: BodyResponseCallback<Schema$Groups>): void;
/**
* groupsSettings.groups.update
* @desc Updates an existing resource.
* @alias groupsSettings.groups.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.groupUniqueId The resource ID
* @param {().Groups} 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$Groups$Update, options?: MethodOptions): GaxiosPromise<Schema$Groups>;
update(params: Params$Resource$Groups$Update, options: MethodOptions | BodyResponseCallback<Schema$Groups>, callback: BodyResponseCallback<Schema$Groups>): void;
update(params: Params$Resource$Groups$Update, callback: BodyResponseCallback<Schema$Groups>): void;
update(callback: BodyResponseCallback<Schema$Groups>): void;
}
interface Params$Resource$Groups$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource ID
*/
groupUniqueId?: string;
}
interface Params$Resource$Groups$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource ID
*/
groupUniqueId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Groups;
}
interface Params$Resource$Groups$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource ID
*/
groupUniqueId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Groups;
}
}