v1.d.ts
34 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
/**
* 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 chat_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;
}
/**
* Hangouts Chat API
*
* Enables bots to fetch information and perform actions in Hangouts Chat.
*
* @example
* const {google} = require('googleapis');
* const chat = google.chat('v1');
*
* @namespace chat
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Chat
*/
class Chat {
context: APIRequestContext;
spaces: Resource$Spaces;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* List of string parameters to supply when the action method is invoked. For
* example, consider three snooze buttons: snooze now, snooze 1 day, snooze
* next week. You might use action method = snooze(), passing the snooze type
* and snooze time in the list of string parameters.
*/
interface Schema$ActionParameter {
/**
* The name of the parameter for the action script.
*/
key?: string;
/**
* The value of the parameter.
*/
value?: string;
}
/**
* Parameters that a bot can use to configure how it's response is posted.
*/
interface Schema$ActionResponse {
/**
* The type of bot response.
*/
type?: string;
/**
* URL for users to auth or config. (Only for REQUEST_CONFIG response
* types.)
*/
url?: string;
}
/**
* Annotations associated with the plain-text body of the message. Example
* plain-text message body: ``` Hello @FooBot how are you!" ``` The
* corresponding annotations metadata: ``` "annotations":[{
* "type":"USER_MENTION", "startIndex":6,
* "length":7, "userMention": { "user": {
* "name":"users/107946847022116401880",
* "displayName":"FooBot",
* "avatarUrl":"https://goo.gl/aeDtrS",
* "type":"BOT" },
* "type":"MENTION" } }] ```
*/
interface Schema$Annotation {
/**
* Length of the substring in the plain-text message body this annotation
* corresponds to.
*/
length?: number;
/**
* Start index (0-based, inclusive) in the plain-text message body this
* annotation corresponds to.
*/
startIndex?: number;
/**
* The type of this annotation.
*/
type?: string;
/**
* The metadata of user mention.
*/
userMention?: Schema$UserMentionMetadata;
}
/**
* A button. Can be a text button or an image button.
*/
interface Schema$Button {
/**
* A button with image and onclick action.
*/
imageButton?: Schema$ImageButton;
/**
* A button with text and onclick action.
*/
textButton?: Schema$TextButton;
}
/**
* A card is a UI element that can contain UI widgets such as texts, images.
*/
interface Schema$Card {
/**
* The actions of this card.
*/
cardActions?: Schema$CardAction[];
/**
* The header of the card. A header usually contains a title and an image.
*/
header?: Schema$CardHeader;
/**
* Name of the card.
*/
name?: string;
/**
* Sections are separated by a line divider.
*/
sections?: Schema$Section[];
}
/**
* A card action is the action associated with the card. For an invoice card,
* a typical action would be: delete invoice, email invoice or open the
* invoice in browser.
*/
interface Schema$CardAction {
/**
* The label used to be displayed in the action menu item.
*/
actionLabel?: string;
/**
* The onclick action for this action item.
*/
onClick?: Schema$OnClick;
}
interface Schema$CardHeader {
/**
* The image's type (e.g. square border or circular border).
*/
imageStyle?: string;
/**
* The URL of the image in the card header.
*/
imageUrl?: string;
/**
* The subtitle of the card header.
*/
subtitle?: string;
/**
* The title must be specified. The header has a fixed height: if both a
* title and subtitle is specified, each will take up 1 line. If only the
* title is specified, it will take up both lines.
*/
title?: string;
}
/**
* Hangouts Chat events.
*/
interface Schema$DeprecatedEvent {
/**
* The form action data associated with an interactive card that was
* clicked. Only populated for CARD_CLICKED events. See the [Interactive
* Cards guide](/hangouts/chat/how-tos/cards-onclick) for more information.
*/
action?: Schema$FormAction;
/**
* The URL the bot should redirect the user to after they have completed an
* authorization or configuration flow outside of Hangouts Chat. See the
* [Authorizing access to 3p services guide](/hangouts/chat/how-tos/auth-3p)
* for more information.
*/
configCompleteRedirectUrl?: string;
/**
* The timestamp indicating when the event was dispatched.
*/
eventTime?: string;
/**
* The message that triggered the event, if applicable.
*/
message?: Schema$Message;
/**
* The room or DM in which the event occurred.
*/
space?: Schema$Space;
/**
* The bot-defined key for the thread related to the event. See the
* thread_key field of the `spaces.message.create` request for more
* information.
*/
threadKey?: string;
/**
* A secret value that bots can use to verify if a request is from Google.
* The token is randomly generated by Google, remains static, and can be
* obtained from the Hangouts Chat API configuration page in the Cloud
* Console. Developers can revoke/regenerate it if needed from the same
* page.
*/
token?: string;
/**
* The type of the event.
*/
type?: string;
/**
* The user that triggered the event.
*/
user?: Schema$User;
}
/**
* 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 {
}
/**
* A form action describes the behavior when the form is submitted. For
* example, an Apps Script can be invoked to handle the form.
*/
interface Schema$FormAction {
/**
* Apps Script function to invoke when the containing element is
* clicked/activated.
*/
actionMethodName?: string;
/**
* List of action parameters.
*/
parameters?: Schema$ActionParameter[];
}
/**
* An image that is specified by a URL and can have an onclick action.
*/
interface Schema$Image {
/**
* The aspect ratio of this image (width/height).
*/
aspectRatio?: number;
/**
* The URL of the image.
*/
imageUrl?: string;
/**
* The onclick action.
*/
onClick?: Schema$OnClick;
}
/**
* An image button with an onclick action.
*/
interface Schema$ImageButton {
/**
* The icon specified by an enum that indices to an icon provided by Chat
* API.
*/
icon?: string;
/**
* The icon specified by a URL.
*/
iconUrl?: string;
/**
* The name of this image_button which will be used for accessibility.
* Default value will be provided if developers don't specify.
*/
name?: string;
/**
* The onclick action.
*/
onClick?: Schema$OnClick;
}
/**
* A UI element contains a key (label) and a value (content). And this element
* may also contain some actions such as onclick button.
*/
interface Schema$KeyValue {
/**
* The text of the bottom label. Formatted text supported.
*/
bottomLabel?: string;
/**
* A button that can be clicked to trigger an action.
*/
button?: Schema$Button;
/**
* The text of the content. Formatted text supported and always required.
*/
content?: string;
/**
* If the content should be multiline.
*/
contentMultiline?: boolean;
/**
* An enum value that will be replaced by the Chat API with the
* corresponding icon image.
*/
icon?: string;
/**
* The icon specified by a URL.
*/
iconUrl?: string;
/**
* The onclick action. Only the top label, bottom label and content region
* are clickable.
*/
onClick?: Schema$OnClick;
/**
* The text of the top label. Formatted text supported.
*/
topLabel?: string;
}
interface Schema$ListMembershipsResponse {
/**
* List of memberships in the requested (or first) page.
*/
memberships?: Schema$Membership[];
/**
* Continuation token to retrieve the next page of results. It will be empty
* for the last page of results.
*/
nextPageToken?: string;
}
interface Schema$ListSpacesResponse {
/**
* Continuation token to retrieve the next page of results. It will be empty
* for the last page of results. Tokens expire in an hour. An error is
* thrown if an expired token is passed.
*/
nextPageToken?: string;
/**
* List of spaces in the requested (or first) page.
*/
spaces?: Schema$Space[];
}
/**
* Represents a membership relation in Hangouts Chat.
*/
interface Schema$Membership {
/**
* The creation time of the membership a.k.a the time at which the member
* joined the space, if applicable.
*/
createTime?: string;
/**
* Member details.
*/
member?: Schema$User;
/**
* Resource name of the membership, in the form
* "spaces/x/members/*". Example:
* spaces/AAAAMpdlehY/members/105115627578887013105
*/
name?: string;
/**
* State of the membership.
*/
state?: string;
}
/**
* A message in Hangouts Chat.
*/
interface Schema$Message {
/**
* Input only. Parameters that a bot can use to configure how its response
* is posted.
*/
actionResponse?: Schema$ActionResponse;
/**
* Output only. Annotations associated with the text in this message.
*/
annotations?: Schema$Annotation[];
/**
* Plain-text body of the message with all bot mentions stripped out.
*/
argumentText?: string;
/**
* Rich, formatted and interactive cards that can be used to display UI
* elements such as: formatted texts, buttons, clickable images. Cards are
* normally displayed below the plain-text body of the message.
*/
cards?: Schema$Card[];
/**
* Output only. The time at which the message was created in Hangouts Chat
* server.
*/
createTime?: string;
/**
* A plain-text description of the message's cards, used when the actual
* cards cannot be displayed (e.g. mobile notifications).
*/
fallbackText?: string;
/**
* Resource name, in the form "spaces/x/messages/*". Example:
* spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
*/
name?: string;
/**
* Text for generating preview chips. This text will not be displayed to the
* user, but any links to images, web pages, videos, etc. included here will
* generate preview chips.
*/
previewText?: string;
/**
* The user who created the message.
*/
sender?: Schema$User;
/**
* The space the message belongs to.
*/
space?: Schema$Space;
/**
* Plain-text body of the message.
*/
text?: string;
/**
* The thread the message belongs to.
*/
thread?: Schema$Thread;
}
/**
* An onclick action (e.g. open a link).
*/
interface Schema$OnClick {
/**
* A form action will be trigger by this onclick if specified.
*/
action?: Schema$FormAction;
/**
* This onclick triggers an open link action if specified.
*/
openLink?: Schema$OpenLink;
}
/**
* A link that opens a new window.
*/
interface Schema$OpenLink {
/**
* The URL to open.
*/
url?: string;
}
/**
* A section contains a collection of widgets that are rendered (vertically)
* in the order that they are specified. Across all platforms, cards have a
* narrow fixed width, so there is currently no need for layout properties
* (e.g. float).
*/
interface Schema$Section {
/**
* The header of the section, text formatted supported.
*/
header?: string;
/**
* A section must contain at least 1 widget.
*/
widgets?: Schema$WidgetMarkup[];
}
/**
* A room or DM in Hangouts Chat.
*/
interface Schema$Space {
/**
* Output only. The display name (only if the space is a room).
*/
displayName?: string;
/**
* Resource name of the space, in the form "spaces/*". Example:
* spaces/AAAAMpdlehYs
*/
name?: string;
/**
* Output only. The type of a space.
*/
type?: string;
}
/**
* A button with text and onclick action.
*/
interface Schema$TextButton {
/**
* The onclick action of the button.
*/
onClick?: Schema$OnClick;
/**
* The text of the button.
*/
text?: string;
}
/**
* A paragraph of text. Formatted text supported.
*/
interface Schema$TextParagraph {
text?: string;
}
/**
* A thread in Hangouts Chat.
*/
interface Schema$Thread {
/**
* Resource name, in the form "spaces/x/threads/*". Example:
* spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
*/
name?: string;
}
/**
* A user in Hangouts Chat.
*/
interface Schema$User {
/**
* The user's display name.
*/
displayName?: string;
/**
* Resource name, in the format "users/*".
*/
name?: string;
/**
* User type.
*/
type?: string;
}
/**
* Annotation metadata for user mentions (@).
*/
interface Schema$UserMentionMetadata {
/**
* The type of user mention.
*/
type?: string;
/**
* The user mentioned.
*/
user?: Schema$User;
}
/**
* A widget is a UI element that presents texts, images, etc.
*/
interface Schema$WidgetMarkup {
/**
* A list of buttons. Buttons is also oneof data and only one of these
* fields should be set.
*/
buttons?: Schema$Button[];
/**
* Display an image in this widget.
*/
image?: Schema$Image;
/**
* Display a key value item in this widget.
*/
keyValue?: Schema$KeyValue;
/**
* Display a text paragraph in this widget.
*/
textParagraph?: Schema$TextParagraph;
}
class Resource$Spaces {
context: APIRequestContext;
members: Resource$Spaces$Members;
messages: Resource$Spaces$Messages;
constructor(context: APIRequestContext);
/**
* chat.spaces.get
* @desc Returns a space.
* @alias chat.spaces.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name of the space, in the form "spaces/x". Example: spaces/AAAAMpdlehY
* @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$Spaces$Get, options?: MethodOptions): GaxiosPromise<Schema$Space>;
get(params: Params$Resource$Spaces$Get, options: MethodOptions | BodyResponseCallback<Schema$Space>, callback: BodyResponseCallback<Schema$Space>): void;
get(params: Params$Resource$Spaces$Get, callback: BodyResponseCallback<Schema$Space>): void;
get(callback: BodyResponseCallback<Schema$Space>): void;
/**
* chat.spaces.list
* @desc Lists spaces the caller is a member of.
* @alias chat.spaces.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Requested page size. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100.
* @param {string=} params.pageToken A token identifying a page of results the server should 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$Spaces$List, options?: MethodOptions): GaxiosPromise<Schema$ListSpacesResponse>;
list(params: Params$Resource$Spaces$List, options: MethodOptions | BodyResponseCallback<Schema$ListSpacesResponse>, callback: BodyResponseCallback<Schema$ListSpacesResponse>): void;
list(params: Params$Resource$Spaces$List, callback: BodyResponseCallback<Schema$ListSpacesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListSpacesResponse>): void;
}
interface Params$Resource$Spaces$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name of the space, in the form "spaces/x". Example:
* spaces/AAAAMpdlehY
*/
name?: string;
}
interface Params$Resource$Spaces$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Requested page size. The value is capped at 1000. Server may return fewer
* results than requested. If unspecified, server will default to 100.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return.
*/
pageToken?: string;
}
class Resource$Spaces$Members {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* chat.spaces.members.get
* @desc Returns a membership.
* @alias chat.spaces.members.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name of the membership to be retrieved, in the form "spaces/x/members/x". Example: spaces/AAAAMpdlehY/members/105115627578887013105
* @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$Spaces$Members$Get, options?: MethodOptions): GaxiosPromise<Schema$Membership>;
get(params: Params$Resource$Spaces$Members$Get, options: MethodOptions | BodyResponseCallback<Schema$Membership>, callback: BodyResponseCallback<Schema$Membership>): void;
get(params: Params$Resource$Spaces$Members$Get, callback: BodyResponseCallback<Schema$Membership>): void;
get(callback: BodyResponseCallback<Schema$Membership>): void;
/**
* chat.spaces.members.list
* @desc Lists human memberships in a space.
* @alias chat.spaces.members.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Requested page size. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100.
* @param {string=} params.pageToken A token identifying a page of results the server should return.
* @param {string} params.parent Required. The resource name of the space for which membership list is to be fetched, in the form "spaces/x". Example: spaces/AAAAMpdlehY
* @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$Spaces$Members$List, options?: MethodOptions): GaxiosPromise<Schema$ListMembershipsResponse>;
list(params: Params$Resource$Spaces$Members$List, options: MethodOptions | BodyResponseCallback<Schema$ListMembershipsResponse>, callback: BodyResponseCallback<Schema$ListMembershipsResponse>): void;
list(params: Params$Resource$Spaces$Members$List, callback: BodyResponseCallback<Schema$ListMembershipsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListMembershipsResponse>): void;
}
interface Params$Resource$Spaces$Members$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name of the membership to be retrieved, in the form
* "spaces/x/members/x". Example:
* spaces/AAAAMpdlehY/members/105115627578887013105
*/
name?: string;
}
interface Params$Resource$Spaces$Members$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Requested page size. The value is capped at 1000. Server may return fewer
* results than requested. If unspecified, server will default to 100.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return.
*/
pageToken?: string;
/**
* Required. The resource name of the space for which membership list is to
* be fetched, in the form "spaces/x". Example: spaces/AAAAMpdlehY
*/
parent?: string;
}
class Resource$Spaces$Messages {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* chat.spaces.messages.create
* @desc Creates a message.
* @alias chat.spaces.messages.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. Space resource name, in the form "spaces/x". Example: spaces/AAAAMpdlehY
* @param {string=} params.threadKey Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.
* @param {().Message} 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$Spaces$Messages$Create, options?: MethodOptions): GaxiosPromise<Schema$Message>;
create(params: Params$Resource$Spaces$Messages$Create, options: MethodOptions | BodyResponseCallback<Schema$Message>, callback: BodyResponseCallback<Schema$Message>): void;
create(params: Params$Resource$Spaces$Messages$Create, callback: BodyResponseCallback<Schema$Message>): void;
create(callback: BodyResponseCallback<Schema$Message>): void;
/**
* chat.spaces.messages.delete
* @desc Deletes a message.
* @alias chat.spaces.messages.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name of the message to be deleted, in the form "spaces/x/messages/x" Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
* @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$Spaces$Messages$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Spaces$Messages$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Spaces$Messages$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* chat.spaces.messages.get
* @desc Returns a message.
* @alias chat.spaces.messages.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name of the message to be retrieved, in the form "spaces/x/messages/x". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
* @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$Spaces$Messages$Get, options?: MethodOptions): GaxiosPromise<Schema$Message>;
get(params: Params$Resource$Spaces$Messages$Get, options: MethodOptions | BodyResponseCallback<Schema$Message>, callback: BodyResponseCallback<Schema$Message>): void;
get(params: Params$Resource$Spaces$Messages$Get, callback: BodyResponseCallback<Schema$Message>): void;
get(callback: BodyResponseCallback<Schema$Message>): void;
/**
* chat.spaces.messages.update
* @desc Updates a message.
* @alias chat.spaces.messages.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Resource name, in the form "spaces/x/messages/x". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
* @param {string=} params.updateMask Required. The field paths to be updated. Currently supported field paths: "text", "cards".
* @param {().Message} 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$Spaces$Messages$Update, options?: MethodOptions): GaxiosPromise<Schema$Message>;
update(params: Params$Resource$Spaces$Messages$Update, options: MethodOptions | BodyResponseCallback<Schema$Message>, callback: BodyResponseCallback<Schema$Message>): void;
update(params: Params$Resource$Spaces$Messages$Update, callback: BodyResponseCallback<Schema$Message>): void;
update(callback: BodyResponseCallback<Schema$Message>): void;
}
interface Params$Resource$Spaces$Messages$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Space resource name, in the form "spaces/x". Example:
* spaces/AAAAMpdlehY
*/
parent?: string;
/**
* Opaque thread identifier string that can be specified to group messages
* into a single thread. If this is the first message with a given thread
* identifier, a new thread is created. Subsequent messages with the same
* thread identifier will be posted into the same thread. This relieves bots
* and webhooks from having to store the Hangouts Chat thread ID of a thread
* (created earlier by them) to post further updates to it. Has no effect
* if thread field, corresponding to an existing thread, is set in message.
*/
threadKey?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Message;
}
interface Params$Resource$Spaces$Messages$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name of the message to be deleted, in the form
* "spaces/x/messages/x" Example:
* spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
*/
name?: string;
}
interface Params$Resource$Spaces$Messages$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name of the message to be retrieved, in the form
* "spaces/x/messages/x". Example:
* spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
*/
name?: string;
}
interface Params$Resource$Spaces$Messages$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Resource name, in the form "spaces/x/messages/x". Example:
* spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
*/
name?: string;
/**
* Required. The field paths to be updated. Currently supported field
* paths: "text", "cards".
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Message;
}
}