google-apis-chat_v1 0.45.0 → 0.47.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -164,7 +164,8 @@ module Google
164
164
  class Attachment
165
165
  include Google::Apis::Core::Hashable
166
166
 
167
- # A reference to the data of an attachment.
167
+ # A reference to the attachment data. This is used with the media API to
168
+ # download the attachment data.
168
169
  # Corresponds to the JSON property `attachmentDataRef`
169
170
  # @return [Google::Apis::ChatV1::AttachmentDataRef]
170
171
  attr_accessor :attachment_data_ref
@@ -226,7 +227,7 @@ module Google
226
227
  end
227
228
  end
228
229
 
229
- # A reference to the data of an attachment.
230
+ #
230
231
  class AttachmentDataRef
231
232
  include Google::Apis::Core::Hashable
232
233
 
@@ -310,7 +311,7 @@ module Google
310
311
 
311
312
  # A card action is the action associated with the card. For an invoice card, a
312
313
  # typical action would be: delete invoice, email invoice or open the invoice in
313
- # browser.
314
+ # browser. Not supported by Google Chat apps.
314
315
  class CardAction
315
316
  include Google::Apis::Core::Hashable
316
317
 
@@ -378,24 +379,29 @@ module Google
378
379
  class CardWithId
379
380
  include Google::Apis::Core::Hashable
380
381
 
381
- # A card is a UI element that can contain UI widgets such as text and images.
382
- # For more information, see Cards . For example, the following JSON creates a
383
- # card that has a header with the name, position, icons, and link for a contact,
384
- # followed by a section with contact information like email and phone number. ```
385
- # ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "imageStyle":
386
- # "ImageStyle.AVATAR", "imageUrl": "https://example.com/sasha.png", "
387
- # imageAltText": "Avatar for Sasha" `, "sections" : [ ` "header": "Contact Info",
388
- # "widgets": [ ` "decorated_text": ` "icon": ` "knownIcon": "EMAIL" `, "content"
389
- # : "sasha@example.com" ` `, ` "decoratedText": ` "icon": ` "knownIcon": "PERSON"
390
- # `, "content": "Online" ` `, ` "decoratedText": ` "icon": ` "knownIcon": "
391
- # PHONE" `, "content": "+1 (555) 555-1234" ` `, ` "buttons": [ ` "textButton": `
392
- # "text": "Share", `, "onClick": ` "openLink": ` "url": "https://example.com/
393
- # share" ` ` `, ` "textButton": ` "text": "Edit", `, "onClick": ` "action": ` "
394
- # function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT" ` ]
395
- # , "loadIndicator": "LoadIndicator.SPINNER" ` ` ` ] ` ], "collapsible": true, "
396
- # uncollapsibleWidgetsCount": 3 ` ], "cardActions": [ ` "actionLabel": "Send
397
- # Feedback", "onClick": ` "openLink": ` "url": "https://example.com/feedback" ` `
398
- # ` ], "name": "contact-card-K3wB6arF2H9L" ` ```
382
+ # Cards support a defined layout, interactive UI elements like buttons, and rich
383
+ # media like images. Use cards to present detailed information, gather
384
+ # information from users, and guide users to take a next step. In Google Chat,
385
+ # cards appear in several places: - As stand-alone messages. - Accompanying a
386
+ # text message, just beneath the text message. - As a [dialog](https://
387
+ # developers.google.com/chat/how-tos/dialogs). The following example JSON
388
+ # creates a "contact card" that features: - A header with the contact's name,
389
+ # job title, avatar picture. - A section with the contact information, including
390
+ # formatted text. - Buttons that users can click to share the contact or see
391
+ # more or less info. ![Example contact card](https://developers.google.com/chat/
392
+ # images/card_api_reference.png) ``` ` "cardsV2": [ ` "cardId": "unique-card-id",
393
+ # "card": ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "
394
+ # imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.
395
+ # png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", `, "sections":
396
+ # [ ` "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount"
397
+ # : 1, "widgets": [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL", `,
398
+ # "text": "sasha@example.com", ` `, ` "decoratedText": ` "startIcon": ` "
399
+ # knownIcon": "PERSON", `, "text": "Online", `, `, ` "decoratedText": ` "
400
+ # startIcon": ` "knownIcon": "PHONE", `, "text": "+1 (555) 555-1234", ` `, ` "
401
+ # buttonList": ` "buttons": [ ` "text": "Share", "onClick": ` "openLink": ` "url"
402
+ # : "https://example.com/share", ` ` `, ` "text": "Edit", "onClick": ` "action":
403
+ # ` "function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT",
404
+ # ` ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
399
405
  # Corresponds to the JSON property `card`
400
406
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
401
407
  attr_accessor :card
@@ -775,24 +781,29 @@ module Google
775
781
  class Dialog
776
782
  include Google::Apis::Core::Hashable
777
783
 
778
- # A card is a UI element that can contain UI widgets such as text and images.
779
- # For more information, see Cards . For example, the following JSON creates a
780
- # card that has a header with the name, position, icons, and link for a contact,
781
- # followed by a section with contact information like email and phone number. ```
782
- # ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "imageStyle":
783
- # "ImageStyle.AVATAR", "imageUrl": "https://example.com/sasha.png", "
784
- # imageAltText": "Avatar for Sasha" `, "sections" : [ ` "header": "Contact Info",
785
- # "widgets": [ ` "decorated_text": ` "icon": ` "knownIcon": "EMAIL" `, "content"
786
- # : "sasha@example.com" ` `, ` "decoratedText": ` "icon": ` "knownIcon": "PERSON"
787
- # `, "content": "Online" ` `, ` "decoratedText": ` "icon": ` "knownIcon": "
788
- # PHONE" `, "content": "+1 (555) 555-1234" ` `, ` "buttons": [ ` "textButton": `
789
- # "text": "Share", `, "onClick": ` "openLink": ` "url": "https://example.com/
790
- # share" ` ` `, ` "textButton": ` "text": "Edit", `, "onClick": ` "action": ` "
791
- # function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT" ` ]
792
- # , "loadIndicator": "LoadIndicator.SPINNER" ` ` ` ] ` ], "collapsible": true, "
793
- # uncollapsibleWidgetsCount": 3 ` ], "cardActions": [ ` "actionLabel": "Send
794
- # Feedback", "onClick": ` "openLink": ` "url": "https://example.com/feedback" ` `
795
- # ` ], "name": "contact-card-K3wB6arF2H9L" ` ```
784
+ # Cards support a defined layout, interactive UI elements like buttons, and rich
785
+ # media like images. Use cards to present detailed information, gather
786
+ # information from users, and guide users to take a next step. In Google Chat,
787
+ # cards appear in several places: - As stand-alone messages. - Accompanying a
788
+ # text message, just beneath the text message. - As a [dialog](https://
789
+ # developers.google.com/chat/how-tos/dialogs). The following example JSON
790
+ # creates a "contact card" that features: - A header with the contact's name,
791
+ # job title, avatar picture. - A section with the contact information, including
792
+ # formatted text. - Buttons that users can click to share the contact or see
793
+ # more or less info. ![Example contact card](https://developers.google.com/chat/
794
+ # images/card_api_reference.png) ``` ` "cardsV2": [ ` "cardId": "unique-card-id",
795
+ # "card": ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "
796
+ # imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.
797
+ # png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", `, "sections":
798
+ # [ ` "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount"
799
+ # : 1, "widgets": [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL", `,
800
+ # "text": "sasha@example.com", ` `, ` "decoratedText": ` "startIcon": ` "
801
+ # knownIcon": "PERSON", `, "text": "Online", `, `, ` "decoratedText": ` "
802
+ # startIcon": ` "knownIcon": "PHONE", `, "text": "+1 (555) 555-1234", ` `, ` "
803
+ # buttonList": ` "buttons": [ ` "text": "Share", "onClick": ` "openLink": ` "url"
804
+ # : "https://example.com/share", ` ` `, ` "text": "Edit", "onClick": ` "action":
805
+ # ` "function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT",
806
+ # ` ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
796
807
  # Corresponds to the JSON property `body`
797
808
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
798
809
  attr_accessor :body
@@ -903,12 +914,27 @@ module Google
903
914
  class GoogleAppsCardV1Action
904
915
  include Google::Apis::Core::Hashable
905
916
 
906
- # Apps Script function to invoke when the containing element is clicked/
907
- # activated.
917
+ # A custom function to invoke when the containing element is clicked or othrwise
918
+ # activated. For example usage, see [Create interactive cards](https://
919
+ # developers.google.com/chat/how-tos/cards-onclick).
908
920
  # Corresponds to the JSON property `function`
909
921
  # @return [String]
910
922
  attr_accessor :function
911
923
 
924
+ # Optional. Required when opening a [dialog](https://developers.google.com/chat/
925
+ # how-tos/dialogs). What to do in response to an interaction with a user, such
926
+ # as a user clicking button on a card message. If unspecified, the app responds
927
+ # by executing an `action` - like opening a link or running a function - as
928
+ # normal. By specifying an `interaction`, the app can respond in special
929
+ # interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the
930
+ # app can open a [dialog](https://developers.google.com/chat/how-tos/dialogs).
931
+ # When specified, a loading indicator is not shown. Supported by Chat apps, but
932
+ # not Google Workspace Add-ons. If specified for an add-on, the entire card is
933
+ # stripped and nothing is shown in the client.
934
+ # Corresponds to the JSON property `interaction`
935
+ # @return [String]
936
+ attr_accessor :interaction
937
+
912
938
  # Specifies the loading indicator that the action displays while making the call
913
939
  # to the action.
914
940
  # Corresponds to the JSON property `loadIndicator`
@@ -931,7 +957,7 @@ module Google
931
957
  # card use [LoadIndicator.SPINNER](https://developers.google.com/workspace/add-
932
958
  # ons/reference/rpc/google.apps.card.v1#loadindicator) for all actions, as this
933
959
  # locks the UI to ensure no changes are made by the user while the action is
934
- # being processed. Not supported by Google Chat apps.
960
+ # being processed. Not supported by Chat apps.
935
961
  # Corresponds to the JSON property `persistValues`
936
962
  # @return [Boolean]
937
963
  attr_accessor :persist_values
@@ -944,6 +970,7 @@ module Google
944
970
  # Update properties of this object
945
971
  def update!(**args)
946
972
  @function = args[:function] if args.key?(:function)
973
+ @interaction = args[:interaction] if args.key?(:interaction)
947
974
  @load_indicator = args[:load_indicator] if args.key?(:load_indicator)
948
975
  @parameters = args[:parameters] if args.key?(:parameters)
949
976
  @persist_values = args[:persist_values] if args.key?(:persist_values)
@@ -953,7 +980,9 @@ module Google
953
980
  # List of string parameters to supply when the action method is invoked. For
954
981
  # example, consider three snooze buttons: snooze now, snooze 1 day, snooze next
955
982
  # week. You might use action method = snooze(), passing the snooze type and
956
- # snooze time in the list of string parameters.
983
+ # snooze time in the list of string parameters. To learn more, see [
984
+ # CommonEventObject](https://developers.google.com/chat/api/reference/rest/v1/
985
+ # Event#commoneventobject).
957
986
  class GoogleAppsCardV1ActionParameter
958
987
  include Google::Apis::Core::Hashable
959
988
 
@@ -978,7 +1007,7 @@ module Google
978
1007
  end
979
1008
  end
980
1009
 
981
- # Represents the complete border style applied to widgets.
1010
+ # Represents the complete border style applied to items in a widget.
982
1011
  class GoogleAppsCardV1BorderStyle
983
1012
  include Google::Apis::Core::Hashable
984
1013
 
@@ -1053,12 +1082,17 @@ module Google
1053
1082
  end
1054
1083
  end
1055
1084
 
1056
- # A button. Can be a text button or an image button.
1085
+ # A text, icon, or text + icon button that users can click. To make an image a
1086
+ # clickable button, specify an Image (not an ImageComponent) and set an `onClick`
1087
+ # action.
1057
1088
  class GoogleAppsCardV1Button
1058
1089
  include Google::Apis::Core::Hashable
1059
1090
 
1060
- # The alternative text used for accessibility. Has no effect when an icon is set;
1061
- # use `icon.alt_text` instead.
1091
+ # The alternative text used for accessibility. Set descriptive text that lets
1092
+ # users know what the button does. For example, if a button opens a hyperlink,
1093
+ # you might write: "Opens a new browser tab and navigates to the Google Chat
1094
+ # developer documentation at https://developers.google.com/chat". Has no effect
1095
+ # when an icon is set; use `icon.alt_text` instead.
1062
1096
  # Corresponds to the JSON property `altText`
1063
1097
  # @return [String]
1064
1098
  attr_accessor :alt_text
@@ -1112,24 +1146,28 @@ module Google
1112
1146
  # @return [Google::Apis::ChatV1::Color]
1113
1147
  attr_accessor :color
1114
1148
 
1115
- # If `true`, the button is displayed in a disabled state and doesn't respond to
1149
+ # If `true`, the button is displayed in an inactive state and doesn't respond to
1116
1150
  # user actions.
1117
1151
  # Corresponds to the JSON property `disabled`
1118
1152
  # @return [Boolean]
1119
1153
  attr_accessor :disabled
1120
1154
  alias_method :disabled?, :disabled
1121
1155
 
1122
- # The icon image.
1156
+ # An icon displayed in a widget on a card. Supports [standard](https://
1157
+ # developers.google.com/chat/api/guides/message-formats/cards) and [custom](
1158
+ # https://developers.google.com/chat/api/guides/message-formats/cards#
1159
+ # customicons) icons.
1123
1160
  # Corresponds to the JSON property `icon`
1124
1161
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
1125
1162
  attr_accessor :icon
1126
1163
 
1127
- # Represents the response to an `onClick` event.
1164
+ # Represents how to respond when users click an interactive element on a card,
1165
+ # such as a button.
1128
1166
  # Corresponds to the JSON property `onClick`
1129
1167
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1OnClick]
1130
1168
  attr_accessor :on_click
1131
1169
 
1132
- # The text of the button.
1170
+ # The text displayed inside the button.
1133
1171
  # Corresponds to the JSON property `text`
1134
1172
  # @return [String]
1135
1173
  attr_accessor :text
@@ -1168,30 +1206,36 @@ module Google
1168
1206
  end
1169
1207
  end
1170
1208
 
1171
- # A card is a UI element that can contain UI widgets such as text and images.
1172
- # For more information, see Cards . For example, the following JSON creates a
1173
- # card that has a header with the name, position, icons, and link for a contact,
1174
- # followed by a section with contact information like email and phone number. ```
1175
- # ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "imageStyle":
1176
- # "ImageStyle.AVATAR", "imageUrl": "https://example.com/sasha.png", "
1177
- # imageAltText": "Avatar for Sasha" `, "sections" : [ ` "header": "Contact Info",
1178
- # "widgets": [ ` "decorated_text": ` "icon": ` "knownIcon": "EMAIL" `, "content"
1179
- # : "sasha@example.com" ` `, ` "decoratedText": ` "icon": ` "knownIcon": "PERSON"
1180
- # `, "content": "Online" ` `, ` "decoratedText": ` "icon": ` "knownIcon": "
1181
- # PHONE" `, "content": "+1 (555) 555-1234" ` `, ` "buttons": [ ` "textButton": `
1182
- # "text": "Share", `, "onClick": ` "openLink": ` "url": "https://example.com/
1183
- # share" ` ` `, ` "textButton": ` "text": "Edit", `, "onClick": ` "action": ` "
1184
- # function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT" ` ]
1185
- # , "loadIndicator": "LoadIndicator.SPINNER" ` ` ` ] ` ], "collapsible": true, "
1186
- # uncollapsibleWidgetsCount": 3 ` ], "cardActions": [ ` "actionLabel": "Send
1187
- # Feedback", "onClick": ` "openLink": ` "url": "https://example.com/feedback" ` `
1188
- # ` ], "name": "contact-card-K3wB6arF2H9L" ` ```
1209
+ # Cards support a defined layout, interactive UI elements like buttons, and rich
1210
+ # media like images. Use cards to present detailed information, gather
1211
+ # information from users, and guide users to take a next step. In Google Chat,
1212
+ # cards appear in several places: - As stand-alone messages. - Accompanying a
1213
+ # text message, just beneath the text message. - As a [dialog](https://
1214
+ # developers.google.com/chat/how-tos/dialogs). The following example JSON
1215
+ # creates a "contact card" that features: - A header with the contact's name,
1216
+ # job title, avatar picture. - A section with the contact information, including
1217
+ # formatted text. - Buttons that users can click to share the contact or see
1218
+ # more or less info. ![Example contact card](https://developers.google.com/chat/
1219
+ # images/card_api_reference.png) ``` ` "cardsV2": [ ` "cardId": "unique-card-id",
1220
+ # "card": ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "
1221
+ # imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.
1222
+ # png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", `, "sections":
1223
+ # [ ` "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount"
1224
+ # : 1, "widgets": [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL", `,
1225
+ # "text": "sasha@example.com", ` `, ` "decoratedText": ` "startIcon": ` "
1226
+ # knownIcon": "PERSON", `, "text": "Online", `, `, ` "decoratedText": ` "
1227
+ # startIcon": ` "knownIcon": "PHONE", `, "text": "+1 (555) 555-1234", ` `, ` "
1228
+ # buttonList": ` "buttons": [ ` "text": "Share", "onClick": ` "openLink": ` "url"
1229
+ # : "https://example.com/share", ` ` `, ` "text": "Edit", "onClick": ` "action":
1230
+ # ` "function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT",
1231
+ # ` ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
1189
1232
  class GoogleAppsCardV1Card
1190
1233
  include Google::Apis::Core::Hashable
1191
1234
 
1192
- # The card's actions. Actions are added to the card's generated toolbar menu.
1193
- # For example, the following JSON constructs a card action menu with Settings
1194
- # and Send Feedback options: ``` "card_actions": [ ` "actionLabel": "Settings", "
1235
+ # The card's actions. Actions are added to the card's toolbar menu. Because Chat
1236
+ # app cards have no toolbar, `cardActions[]` is not supported by Chat apps. For
1237
+ # example, the following JSON constructs a card action menu with Settings and
1238
+ # Send Feedback options: ``` "card_actions": [ ` "actionLabel": "Settings", "
1195
1239
  # onClick": ` "action": ` "functionName": "goToView", "parameters": [ ` "key": "
1196
1240
  # viewType", "value": "SETTING" ` ], "loadIndicator": "LoadIndicator.SPINNER" ` `
1197
1241
  # `, ` "actionLabel": "Send Feedback", "onClick": ` "openLink": ` "url": "https:
@@ -1200,12 +1244,17 @@ module Google
1200
1244
  # @return [Array<Google::Apis::ChatV1::GoogleAppsCardV1CardAction>]
1201
1245
  attr_accessor :card_actions
1202
1246
 
1203
- # The `peekCardHeader` display style for. Not supported by Google Chat apps.
1247
+ # In Google Workspace add-ons, sets the display properties of the `
1248
+ # peekCardHeader`. Not supported by Chat apps.
1204
1249
  # Corresponds to the JSON property `displayStyle`
1205
1250
  # @return [String]
1206
1251
  attr_accessor :display_style
1207
1252
 
1208
- # A persistent (sticky) footer that is added to the bottom of the card.
1253
+ # A persistent (sticky) footer that that appears at the bottom of the card.
1254
+ # Setting `fixedFooter` without specifying a `primaryButton` or a `
1255
+ # secondaryButton` causes an error. Chat apps support `fixedFooter` in [dialogs](
1256
+ # https://developers.google.com/chat/how-tos/dialogs), but not in [card messages]
1257
+ # (https://developers.google.com/chat/api/guides/message-formats/cards).
1209
1258
  # Corresponds to the JSON property `fixedFooter`
1210
1259
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1CardFixedFooter]
1211
1260
  attr_accessor :fixed_footer
@@ -1215,7 +1264,8 @@ module Google
1215
1264
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1CardHeader]
1216
1265
  attr_accessor :header
1217
1266
 
1218
- # Name of the card. Used as a card identifier in card navigation.
1267
+ # Name of the card. Used as a card identifier in card navigation. Because Chat
1268
+ # apps don't support card navigation, they ignore this field.
1219
1269
  # Corresponds to the JSON property `name`
1220
1270
  # @return [String]
1221
1271
  attr_accessor :name
@@ -1225,7 +1275,8 @@ module Google
1225
1275
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1CardHeader]
1226
1276
  attr_accessor :peek_card_header
1227
1277
 
1228
- # Sections are separated by a line divider.
1278
+ # Contains a collection of widgets. Each section has its own, optional header.
1279
+ # Sections are visually separated by a line divider.
1229
1280
  # Corresponds to the JSON property `sections`
1230
1281
  # @return [Array<Google::Apis::ChatV1::GoogleAppsCardV1Section>]
1231
1282
  attr_accessor :sections
@@ -1248,7 +1299,7 @@ module Google
1248
1299
 
1249
1300
  # A card action is the action associated with the card. For example, an invoice
1250
1301
  # card might include actions such as delete invoice, email invoice, or open the
1251
- # invoice in a browser.
1302
+ # invoice in a browser. Not supported by Chat apps.
1252
1303
  class GoogleAppsCardV1CardAction
1253
1304
  include Google::Apis::Core::Hashable
1254
1305
 
@@ -1257,7 +1308,8 @@ module Google
1257
1308
  # @return [String]
1258
1309
  attr_accessor :action_label
1259
1310
 
1260
- # Represents the response to an `onClick` event.
1311
+ # Represents how to respond when users click an interactive element on a card,
1312
+ # such as a button.
1261
1313
  # Corresponds to the JSON property `onClick`
1262
1314
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1OnClick]
1263
1315
  attr_accessor :on_click
@@ -1273,16 +1325,24 @@ module Google
1273
1325
  end
1274
1326
  end
1275
1327
 
1276
- # A persistent (sticky) footer that is added to the bottom of the card.
1328
+ # A persistent (sticky) footer that that appears at the bottom of the card.
1329
+ # Setting `fixedFooter` without specifying a `primaryButton` or a `
1330
+ # secondaryButton` causes an error. Chat apps support `fixedFooter` in [dialogs](
1331
+ # https://developers.google.com/chat/how-tos/dialogs), but not in [card messages]
1332
+ # (https://developers.google.com/chat/api/guides/message-formats/cards).
1277
1333
  class GoogleAppsCardV1CardFixedFooter
1278
1334
  include Google::Apis::Core::Hashable
1279
1335
 
1280
- # A button. Can be a text button or an image button.
1336
+ # A text, icon, or text + icon button that users can click. To make an image a
1337
+ # clickable button, specify an Image (not an ImageComponent) and set an `onClick`
1338
+ # action.
1281
1339
  # Corresponds to the JSON property `primaryButton`
1282
1340
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
1283
1341
  attr_accessor :primary_button
1284
1342
 
1285
- # A button. Can be a text button or an image button.
1343
+ # A text, icon, or text + icon button that users can click. To make an image a
1344
+ # clickable button, specify an Image (not an ImageComponent) and set an `onClick`
1345
+ # action.
1286
1346
  # Corresponds to the JSON property `secondaryButton`
1287
1347
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
1288
1348
  attr_accessor :secondary_button
@@ -1307,17 +1367,18 @@ module Google
1307
1367
  # @return [String]
1308
1368
  attr_accessor :image_alt_text
1309
1369
 
1310
- # The image's type.
1370
+ # The shape used to crop the image.
1311
1371
  # Corresponds to the JSON property `imageType`
1312
1372
  # @return [String]
1313
1373
  attr_accessor :image_type
1314
1374
 
1315
- # The URL of the image in the card header.
1375
+ # The HTTPS URL of the image in the card header.
1316
1376
  # Corresponds to the JSON property `imageUrl`
1317
1377
  # @return [String]
1318
1378
  attr_accessor :image_url
1319
1379
 
1320
- # The subtitle of the card header.
1380
+ # The subtitle of the card header. If specified, appears on its own line below
1381
+ # the `title`.
1321
1382
  # Corresponds to the JSON property `subtitle`
1322
1383
  # @return [String]
1323
1384
  attr_accessor :subtitle
@@ -1343,18 +1404,25 @@ module Google
1343
1404
  end
1344
1405
  end
1345
1406
 
1346
- # The widget that lets users to specify a date and time. Not supported by Google
1347
- # Chat apps.
1407
+ # Lets users specify a date, a time, or both a date and a time. Accepts text
1408
+ # input from users, but features an interactive date and time selector that
1409
+ # helps users enter correctly-formatted dates and times. If users enter a date
1410
+ # or time incorrectly, the widget shows an error that prompts users to enter the
1411
+ # correct format. Not supported by Chat apps. Support by Chat apps coming soon.
1348
1412
  class GoogleAppsCardV1DateTimePicker
1349
1413
  include Google::Apis::Core::Hashable
1350
1414
 
1351
- # The label for the field that displays to the user.
1415
+ # The text that prompts users to enter a date, time, or datetime. Specify text
1416
+ # that helps the user enter the information your app needs. For example, if
1417
+ # users are setting an appointment, then a label like "Appointment date" or "
1418
+ # Appointment date and time" might work well.
1352
1419
  # Corresponds to the JSON property `label`
1353
1420
  # @return [String]
1354
1421
  attr_accessor :label
1355
1422
 
1356
- # The name of the text input that's used in `formInput`, and uniquely identifies
1357
- # this input.
1423
+ # The name by which the datetime picker is identified in a form input event. For
1424
+ # details about working with form inputs, see [Receive form data](https://
1425
+ # developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
1358
1426
  # Corresponds to the JSON property `name`
1359
1427
  # @return [String]
1360
1428
  attr_accessor :name
@@ -1372,16 +1440,17 @@ module Google
1372
1440
  # @return [Fixnum]
1373
1441
  attr_accessor :timezone_offset_date
1374
1442
 
1375
- # The type of the date/time picker.
1443
+ # What kind of date and time input the datetime picker supports.
1376
1444
  # Corresponds to the JSON property `type`
1377
1445
  # @return [String]
1378
1446
  attr_accessor :type
1379
1447
 
1380
- # The value to display as the default value before user input or previous user
1381
- # input. It is represented in milliseconds (Epoch time). For `DATE_AND_TIME`
1382
- # type, the full epoch value is used. For `DATE_ONLY` type, only date of the
1383
- # epoch time is used. For `TIME_ONLY` type, only time of the epoch time is used.
1384
- # For example, you can set epoch time to `3 * 60 * 60 * 1000` to represent 3am.
1448
+ # The value displayed as the default value before user input or previous user
1449
+ # input, represented in milliseconds ([Epoch time](https://en.wikipedia.org/wiki/
1450
+ # Unix_time)). For `DATE_AND_TIME` type, the full epoch value is used. For `
1451
+ # DATE_ONLY` type, only date of the epoch time is used. For `TIME_ONLY` type,
1452
+ # only time of the epoch time is used. For example, to represent 3:00 AM, set
1453
+ # epoch time to `3 * 60 * 60 * 1000`.
1385
1454
  # Corresponds to the JSON property `valueMsEpoch`
1386
1455
  # @return [Fixnum]
1387
1456
  attr_accessor :value_ms_epoch
@@ -1407,53 +1476,73 @@ module Google
1407
1476
  class GoogleAppsCardV1DecoratedText
1408
1477
  include Google::Apis::Core::Hashable
1409
1478
 
1410
- # The formatted text label that shows below the main text.
1479
+ # The text that appears below `text`. Always truncates. Supports simple
1480
+ # formatting. See Text formatting for formatting details.
1411
1481
  # Corresponds to the JSON property `bottomLabel`
1412
1482
  # @return [String]
1413
1483
  attr_accessor :bottom_label
1414
1484
 
1415
- # A button. Can be a text button or an image button.
1485
+ # A text, icon, or text + icon button that users can click. To make an image a
1486
+ # clickable button, specify an Image (not an ImageComponent) and set an `onClick`
1487
+ # action.
1416
1488
  # Corresponds to the JSON property `button`
1417
1489
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
1418
1490
  attr_accessor :button
1419
1491
 
1420
- # An icon displayed after the text.
1492
+ # An icon displayed in a widget on a card. Supports [standard](https://
1493
+ # developers.google.com/chat/api/guides/message-formats/cards) and [custom](
1494
+ # https://developers.google.com/chat/api/guides/message-formats/cards#
1495
+ # customicons) icons.
1421
1496
  # Corresponds to the JSON property `endIcon`
1422
1497
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
1423
1498
  attr_accessor :end_icon
1424
1499
 
1425
- # Deprecated in favor of start_icon.
1500
+ # An icon displayed in a widget on a card. Supports [standard](https://
1501
+ # developers.google.com/chat/api/guides/message-formats/cards) and [custom](
1502
+ # https://developers.google.com/chat/api/guides/message-formats/cards#
1503
+ # customicons) icons.
1426
1504
  # Corresponds to the JSON property `icon`
1427
1505
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
1428
1506
  attr_accessor :icon
1429
1507
 
1430
- # Represents the response to an `onClick` event.
1508
+ # Represents how to respond when users click an interactive element on a card,
1509
+ # such as a button.
1431
1510
  # Corresponds to the JSON property `onClick`
1432
1511
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1OnClick]
1433
1512
  attr_accessor :on_click
1434
1513
 
1435
- # The icon displayed in front of the text.
1514
+ # An icon displayed in a widget on a card. Supports [standard](https://
1515
+ # developers.google.com/chat/api/guides/message-formats/cards) and [custom](
1516
+ # https://developers.google.com/chat/api/guides/message-formats/cards#
1517
+ # customicons) icons.
1436
1518
  # Corresponds to the JSON property `startIcon`
1437
1519
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
1438
1520
  attr_accessor :start_icon
1439
1521
 
1440
- # Either a toggle-style switch or a checkbox.
1522
+ # Either a toggle-style switch or a checkbox inside a `decoratedText` widget.
1523
+ # Only supported on the `decoratedText` widget. Currently supported in [dialogs](
1524
+ # https://developers.google.com/chat/how-tos/dialogs). Support for [card
1525
+ # messages](https://developers.google.com/chat/api/guides/message-formats/cards)
1526
+ # is coming soon.
1441
1527
  # Corresponds to the JSON property `switchControl`
1442
1528
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1SwitchControl]
1443
1529
  attr_accessor :switch_control
1444
1530
 
1445
- # Required. The main widget formatted text. See Text formatting for details.
1531
+ # Required. The primary text. Supports simple formatting. See Text formatting
1532
+ # for formatting details.
1446
1533
  # Corresponds to the JSON property `text`
1447
1534
  # @return [String]
1448
1535
  attr_accessor :text
1449
1536
 
1450
- # The formatted text label that shows above the main text.
1537
+ # The text that appears above `text`. Always truncates. Supports simple
1538
+ # formatting. See Text formatting for formatting details.
1451
1539
  # Corresponds to the JSON property `topLabel`
1452
1540
  # @return [String]
1453
1541
  attr_accessor :top_label
1454
1542
 
1455
- # The wrap text setting. If `true`, the text is wrapped and displayed in
1456
- # multiline. Otherwise, the text is truncated.
1543
+ # The wrap text setting. If `true`, the text wraps and displays on multiple
1544
+ # lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel`
1545
+ # and `bottomLabel`.
1457
1546
  # Corresponds to the JSON property `wrapText`
1458
1547
  # @return [Boolean]
1459
1548
  attr_accessor :wrap_text
@@ -1478,7 +1567,8 @@ module Google
1478
1567
  end
1479
1568
  end
1480
1569
 
1481
- # A divider that appears in between widgets.
1570
+ # Displays a divider between widgets, a horizontal line. For example, the
1571
+ # following JSON creates a divider: ``` "divider": ` ` ```
1482
1572
  class GoogleAppsCardV1Divider
1483
1573
  include Google::Apis::Core::Hashable
1484
1574
 
@@ -1491,11 +1581,23 @@ module Google
1491
1581
  end
1492
1582
  end
1493
1583
 
1494
- # Represents a Grid widget that displays items in a configurable grid layout.
1584
+ # Displays a grid with a collection of items. A grid supports any number of
1585
+ # columns and items. The number of rows is determined by items divided by
1586
+ # columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items
1587
+ # and 2 columns has 6 rows. Currently supported in [dialogs](https://developers.
1588
+ # google.com/chat/how-tos/dialogs). Support for [card messages](https://
1589
+ # developers.google.com/chat/api/guides/message-formats/cards) is coming soon.
1590
+ # For example, the following JSON creates a 2 column grid with a single item: ```
1591
+ # "grid": ` "title": "A fine collection of items", "numColumns": 2, "
1592
+ # borderStyle": ` "type": "STROKE", "cornerRadius": 4.0 `, "items": [ "image": `
1593
+ # "imageUri": "https://www.example.com/image.png", "cropStyle": ` "type": "
1594
+ # SQUARE" `, "borderStyle": ` "type": "STROKE" ` `, "title": "An item", "
1595
+ # textAlignment": "CENTER" ], "onClick": ` "openLink": ` "url":"https://www.
1596
+ # example.com" ` ` ` ```
1495
1597
  class GoogleAppsCardV1Grid
1496
1598
  include Google::Apis::Core::Hashable
1497
1599
 
1498
- # Represents the complete border style applied to widgets.
1600
+ # Represents the complete border style applied to items in a widget.
1499
1601
  # Corresponds to the JSON property `borderStyle`
1500
1602
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1BorderStyle]
1501
1603
  attr_accessor :border_style
@@ -1512,7 +1614,8 @@ module Google
1512
1614
  # @return [Array<Google::Apis::ChatV1::GoogleAppsCardV1GridItem>]
1513
1615
  attr_accessor :items
1514
1616
 
1515
- # Represents the response to an `onClick` event.
1617
+ # Represents how to respond when users click an interactive element on a card,
1618
+ # such as a button.
1516
1619
  # Corresponds to the JSON property `onClick`
1517
1620
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1OnClick]
1518
1621
  attr_accessor :on_click
@@ -1561,11 +1664,6 @@ module Google
1561
1664
  # @return [String]
1562
1665
  attr_accessor :subtitle
1563
1666
 
1564
- # The horizontal alignment of the grid item's text.
1565
- # Corresponds to the JSON property `textAlignment`
1566
- # @return [String]
1567
- attr_accessor :text_alignment
1568
-
1569
1667
  # The grid item's title.
1570
1668
  # Corresponds to the JSON property `title`
1571
1669
  # @return [String]
@@ -1581,22 +1679,33 @@ module Google
1581
1679
  @image = args[:image] if args.key?(:image)
1582
1680
  @layout = args[:layout] if args.key?(:layout)
1583
1681
  @subtitle = args[:subtitle] if args.key?(:subtitle)
1584
- @text_alignment = args[:text_alignment] if args.key?(:text_alignment)
1585
1682
  @title = args[:title] if args.key?(:title)
1586
1683
  end
1587
1684
  end
1588
1685
 
1589
- #
1686
+ # An icon displayed in a widget on a card. Supports [standard](https://
1687
+ # developers.google.com/chat/api/guides/message-formats/cards) and [custom](
1688
+ # https://developers.google.com/chat/api/guides/message-formats/cards#
1689
+ # customicons) icons.
1590
1690
  class GoogleAppsCardV1Icon
1591
1691
  include Google::Apis::Core::Hashable
1592
1692
 
1593
- # The description of the icon, used for accessibility. The default value is
1594
- # provided if you don't specify one.
1693
+ # Optional. A description of the icon used for accessibility. If unspecified, a
1694
+ # default value is provided. As a best practice, you should set a helpful
1695
+ # description. For example, if an icon displays a user's account portrait, you
1696
+ # could describe it as "A user's account portrait." If the icon displays in a
1697
+ # Button, this alt text takes precedence and overwrites the button's alt text,
1698
+ # so you should write alt text for the button: Set descriptive text that lets
1699
+ # users know what the button does. For example, if a button opens a hyperlink,
1700
+ # you might write: "Opens a new browser tab and navigates to the Google Chat
1701
+ # developer documentation at https://developers.google.com/chat".
1595
1702
  # Corresponds to the JSON property `altText`
1596
1703
  # @return [String]
1597
1704
  attr_accessor :alt_text
1598
1705
 
1599
- # The icon specified by a URL.
1706
+ # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "
1707
+ # https://developers.google.com/chat/images/quickstart-app-avatar.png" ```
1708
+ # Supported file types include `.png` and `.jpg`.
1600
1709
  # Corresponds to the JSON property `iconUrl`
1601
1710
  # @return [String]
1602
1711
  attr_accessor :icon_url
@@ -1607,7 +1716,10 @@ module Google
1607
1716
  # @return [String]
1608
1717
  attr_accessor :image_type
1609
1718
 
1610
- # The icon specified by the string name of a list of known icons.
1719
+ # Display one of the standard icons provided by Google Workspace. For example,
1720
+ # to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For
1721
+ # a full list of supported icons, see [standard icons](https://developers.google.
1722
+ # com/chat/api/guides/message-formats/cards).
1611
1723
  # Corresponds to the JSON property `knownIcon`
1612
1724
  # @return [String]
1613
1725
  attr_accessor :known_icon
@@ -1634,12 +1746,14 @@ module Google
1634
1746
  # @return [String]
1635
1747
  attr_accessor :alt_text
1636
1748
 
1637
- # An image URL.
1749
+ # The `https` URL that hosts the image. For example: ``` https://developers.
1750
+ # google.com/chat/images/quickstart-app-avatar.png ```
1638
1751
  # Corresponds to the JSON property `imageUrl`
1639
1752
  # @return [String]
1640
1753
  attr_accessor :image_url
1641
1754
 
1642
- # Represents the response to an `onClick` event.
1755
+ # Represents how to respond when users click an interactive element on a card,
1756
+ # such as a button.
1643
1757
  # Corresponds to the JSON property `onClick`
1644
1758
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1OnClick]
1645
1759
  attr_accessor :on_click
@@ -1665,12 +1779,14 @@ module Google
1665
1779
  # @return [String]
1666
1780
  attr_accessor :alt_text
1667
1781
 
1668
- # Represents the complete border style applied to widgets.
1782
+ # Represents the complete border style applied to items in a widget.
1669
1783
  # Corresponds to the JSON property `borderStyle`
1670
1784
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1BorderStyle]
1671
1785
  attr_accessor :border_style
1672
1786
 
1673
- # Represents the crop style applied to an image.
1787
+ # Represents the crop style applied to an image. For example, here's how to
1788
+ # apply a 16 by 9 aspect ratio: ``` cropStyle ` "type": "RECTANGLE_CUSTOM", "
1789
+ # aspectRatio": 16/9 ` ```
1674
1790
  # Corresponds to the JSON property `cropStyle`
1675
1791
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1ImageCropStyle]
1676
1792
  attr_accessor :crop_style
@@ -1693,11 +1809,15 @@ module Google
1693
1809
  end
1694
1810
  end
1695
1811
 
1696
- # Represents the crop style applied to an image.
1812
+ # Represents the crop style applied to an image. For example, here's how to
1813
+ # apply a 16 by 9 aspect ratio: ``` cropStyle ` "type": "RECTANGLE_CUSTOM", "
1814
+ # aspectRatio": 16/9 ` ```
1697
1815
  class GoogleAppsCardV1ImageCropStyle
1698
1816
  include Google::Apis::Core::Hashable
1699
1817
 
1700
- # The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`.
1818
+ # The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example,
1819
+ # here's how to apply a 16 by 9 aspect ratio: ``` cropStyle ` "type": "
1820
+ # RECTANGLE_CUSTOM", "aspectRatio": 16/9 ` ```
1701
1821
  # Corresponds to the JSON property `aspectRatio`
1702
1822
  # @return [Float]
1703
1823
  attr_accessor :aspect_ratio
@@ -1718,7 +1838,8 @@ module Google
1718
1838
  end
1719
1839
  end
1720
1840
 
1721
- # Represents the response to an `onClick` event.
1841
+ # Represents how to respond when users click an interactive element on a card,
1842
+ # such as a button.
1722
1843
  class GoogleAppsCardV1OnClick
1723
1844
  include Google::Apis::Core::Hashable
1724
1845
 
@@ -1728,24 +1849,29 @@ module Google
1728
1849
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
1729
1850
  attr_accessor :action
1730
1851
 
1731
- # A card is a UI element that can contain UI widgets such as text and images.
1732
- # For more information, see Cards . For example, the following JSON creates a
1733
- # card that has a header with the name, position, icons, and link for a contact,
1734
- # followed by a section with contact information like email and phone number. ```
1735
- # ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "imageStyle":
1736
- # "ImageStyle.AVATAR", "imageUrl": "https://example.com/sasha.png", "
1737
- # imageAltText": "Avatar for Sasha" `, "sections" : [ ` "header": "Contact Info",
1738
- # "widgets": [ ` "decorated_text": ` "icon": ` "knownIcon": "EMAIL" `, "content"
1739
- # : "sasha@example.com" ` `, ` "decoratedText": ` "icon": ` "knownIcon": "PERSON"
1740
- # `, "content": "Online" ` `, ` "decoratedText": ` "icon": ` "knownIcon": "
1741
- # PHONE" `, "content": "+1 (555) 555-1234" ` `, ` "buttons": [ ` "textButton": `
1742
- # "text": "Share", `, "onClick": ` "openLink": ` "url": "https://example.com/
1743
- # share" ` ` `, ` "textButton": ` "text": "Edit", `, "onClick": ` "action": ` "
1744
- # function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT" ` ]
1745
- # , "loadIndicator": "LoadIndicator.SPINNER" ` ` ` ] ` ], "collapsible": true, "
1746
- # uncollapsibleWidgetsCount": 3 ` ], "cardActions": [ ` "actionLabel": "Send
1747
- # Feedback", "onClick": ` "openLink": ` "url": "https://example.com/feedback" ` `
1748
- # ` ], "name": "contact-card-K3wB6arF2H9L" ` ```
1852
+ # Cards support a defined layout, interactive UI elements like buttons, and rich
1853
+ # media like images. Use cards to present detailed information, gather
1854
+ # information from users, and guide users to take a next step. In Google Chat,
1855
+ # cards appear in several places: - As stand-alone messages. - Accompanying a
1856
+ # text message, just beneath the text message. - As a [dialog](https://
1857
+ # developers.google.com/chat/how-tos/dialogs). The following example JSON
1858
+ # creates a "contact card" that features: - A header with the contact's name,
1859
+ # job title, avatar picture. - A section with the contact information, including
1860
+ # formatted text. - Buttons that users can click to share the contact or see
1861
+ # more or less info. ![Example contact card](https://developers.google.com/chat/
1862
+ # images/card_api_reference.png) ``` ` "cardsV2": [ ` "cardId": "unique-card-id",
1863
+ # "card": ` "header": ` "title": "Sasha", "subtitle": "Software Engineer", "
1864
+ # imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.
1865
+ # png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", `, "sections":
1866
+ # [ ` "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount"
1867
+ # : 1, "widgets": [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL", `,
1868
+ # "text": "sasha@example.com", ` `, ` "decoratedText": ` "startIcon": ` "
1869
+ # knownIcon": "PERSON", `, "text": "Online", `, `, ` "decoratedText": ` "
1870
+ # startIcon": ` "knownIcon": "PHONE", `, "text": "+1 (555) 555-1234", ` `, ` "
1871
+ # buttonList": ` "buttons": [ ` "text": "Share", "onClick": ` "openLink": ` "url"
1872
+ # : "https://example.com/share", ` ` `, ` "text": "Edit", "onClick": ` "action":
1873
+ # ` "function": "goToView", "parameters": [ ` "key": "viewType", "value": "EDIT",
1874
+ # ` ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
1749
1875
  # Corresponds to the JSON property `card`
1750
1876
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
1751
1877
  attr_accessor :card
@@ -1807,33 +1933,38 @@ module Google
1807
1933
  end
1808
1934
 
1809
1935
  # A section contains a collection of widgets that are rendered vertically in the
1810
- # order that they are specified. Across all platforms, cards have a narrow fixed
1811
- # width, so there is currently no need for layout properties, for example, float.
1936
+ # order that they are specified.
1812
1937
  class GoogleAppsCardV1Section
1813
1938
  include Google::Apis::Core::Hashable
1814
1939
 
1815
- # Indicates whether this section is collapsible. If a section is collapsible,
1816
- # the description must be given.
1940
+ # Indicates whether this section is collapsible. Collapsible sections hide some
1941
+ # or all widgets, but users can expand the section to reveal the hidden widgets
1942
+ # by clicking **Show more**. Users can hide the widgets again by clicking **Show
1943
+ # less**. To determine which widgets are hidden, specify `
1944
+ # uncollapsibleWidgetsCount`.
1817
1945
  # Corresponds to the JSON property `collapsible`
1818
1946
  # @return [Boolean]
1819
1947
  attr_accessor :collapsible
1820
1948
  alias_method :collapsible?, :collapsible
1821
1949
 
1822
- # The header of the section. Formatted text is supported.
1950
+ # Text that appears at the top of a section. Supports [simple HTML formatted
1951
+ # text](https://developers.google.com/apps-script/add-ons/concepts/widgets#
1952
+ # text_formatting).
1823
1953
  # Corresponds to the JSON property `header`
1824
1954
  # @return [String]
1825
1955
  attr_accessor :header
1826
1956
 
1827
- # The number of uncollapsible widgets. For example, when a section contains five
1828
- # widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two
1829
- # widgets are always shown and the last three are collapsed as default. The `
1957
+ # The number of uncollapsible widgets which remain visible even when a section
1958
+ # is collapsed. For example, when a section contains five widgets and the `
1959
+ # uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always
1960
+ # shown and the last three are collapsed by default. The `
1830
1961
  # uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `
1831
1962
  # true`.
1832
1963
  # Corresponds to the JSON property `uncollapsibleWidgetsCount`
1833
1964
  # @return [Fixnum]
1834
1965
  attr_accessor :uncollapsible_widgets_count
1835
1966
 
1836
- # A section must contain at least 1 widget.
1967
+ # All the widgets in the section. Must contain at least 1 widget.
1837
1968
  # Corresponds to the JSON property `widgets`
1838
1969
  # @return [Array<Google::Apis::ChatV1::GoogleAppsCardV1Widget>]
1839
1970
  attr_accessor :widgets
@@ -1852,21 +1983,34 @@ module Google
1852
1983
  end
1853
1984
 
1854
1985
  # A widget that creates a UI item with options for users to select. For example,
1855
- # a dropdown menu.
1986
+ # a dropdown menu or check list. Chat apps receive and can process the value of
1987
+ # entered text during form input events. For details about working with form
1988
+ # inputs, see [Receive form data](https://developers.google.com/chat/how-tos/
1989
+ # dialogs#receive_form_data_from_dialogs). When you need to collect data from
1990
+ # users that matches options you set, use a selection input. To collect abstract
1991
+ # data from users, use the text input widget instead. Only supported in [dialogs]
1992
+ # (https://developers.google.com/chat/how-tos/dialogs). Support for [card
1993
+ # messages](https://developers.google.com/chat/api/guides/message-formats/cards)
1994
+ # coming soon.
1856
1995
  class GoogleAppsCardV1SelectionInput
1857
1996
  include Google::Apis::Core::Hashable
1858
1997
 
1859
- # An array of the selected items.
1998
+ # An array of the selected items. For example, all the selected check boxes.
1860
1999
  # Corresponds to the JSON property `items`
1861
2000
  # @return [Array<Google::Apis::ChatV1::GoogleAppsCardV1SelectionItem>]
1862
2001
  attr_accessor :items
1863
2002
 
1864
- # The label displayed ahead of the switch control.
2003
+ # The text that appears above the selection input field in the user interface.
2004
+ # Specify text that helps the user enter the information your app needs. For
2005
+ # example, if users are selecting the urgency of a work ticket from a drop-down
2006
+ # menu, the label might be "Urgency" or "Select urgency".
1865
2007
  # Corresponds to the JSON property `label`
1866
2008
  # @return [String]
1867
2009
  attr_accessor :label
1868
2010
 
1869
- # The name of the text input which is used in `formInput`.
2011
+ # The name by which the selection input is identified in a form input event. For
2012
+ # details about working with form inputs, see [Receive form data](https://
2013
+ # developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
1870
2014
  # Corresponds to the JSON property `name`
1871
2015
  # @return [String]
1872
2016
  attr_accessor :name
@@ -1877,7 +2021,11 @@ module Google
1877
2021
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
1878
2022
  attr_accessor :on_change_action
1879
2023
 
1880
- # The type of the selection.
2024
+ # The way that an option appears to users. Different options support different
2025
+ # types of interactions. For example, users can enable multiple check boxes, but
2026
+ # can only select one value from a dropdown menu. Each selection input supports
2027
+ # one type of selection. Mixing check boxes and switches, for example, is not
2028
+ # supported.
1881
2029
  # Corresponds to the JSON property `type`
1882
2030
  # @return [String]
1883
2031
  attr_accessor :type
@@ -1896,24 +2044,27 @@ module Google
1896
2044
  end
1897
2045
  end
1898
2046
 
1899
- # A selectable item in the switch control.
2047
+ # A selectable item in a selection input, such as a check box or a switch.
1900
2048
  class GoogleAppsCardV1SelectionItem
1901
2049
  include Google::Apis::Core::Hashable
1902
2050
 
1903
- # If more than one item is selected for `RADIO_BUTTON` and `DROPDOWN`, the first
1904
- # selected item is treated as selected and the ones after are ignored.
2051
+ # When `true`, more than one item is selected. If more than one item is selected
2052
+ # for radio buttons and dropdown menus, the first selected item is received and
2053
+ # the ones after are ignored.
1905
2054
  # Corresponds to the JSON property `selected`
1906
2055
  # @return [Boolean]
1907
2056
  attr_accessor :selected
1908
2057
  alias_method :selected?, :selected
1909
2058
 
1910
- # The text to be displayed.
2059
+ # The text displayed to users.
1911
2060
  # Corresponds to the JSON property `text`
1912
2061
  # @return [String]
1913
2062
  attr_accessor :text
1914
2063
 
1915
2064
  # The value associated with this item. The client should use this as a form
1916
- # input value.
2065
+ # input value. For details about working with form inputs, see [Receive form
2066
+ # data](https://developers.google.com/chat/how-tos/dialogs#
2067
+ # receive_form_data_from_dialogs).
1917
2068
  # Corresponds to the JSON property `value`
1918
2069
  # @return [String]
1919
2070
  attr_accessor :value
@@ -1930,11 +2081,12 @@ module Google
1930
2081
  end
1931
2082
  end
1932
2083
 
1933
- # A suggestion item.
2084
+ # One suggested value that users can enter in a text input field.
1934
2085
  class GoogleAppsCardV1SuggestionItem
1935
2086
  include Google::Apis::Core::Hashable
1936
2087
 
1937
- # The suggested autocomplete result.
2088
+ # The value of a suggested input to a text input field. This is equivalent to
2089
+ # what users would enter themselves.
1938
2090
  # Corresponds to the JSON property `text`
1939
2091
  # @return [String]
1940
2092
  attr_accessor :text
@@ -1949,12 +2101,21 @@ module Google
1949
2101
  end
1950
2102
  end
1951
2103
 
1952
- # A container wrapping elements necessary for showing suggestion items used in
1953
- # text input autocomplete.
2104
+ # Suggested values that users can enter. These values appear when users click
2105
+ # inside the text input field. As users type, the suggested values dynamically
2106
+ # filter to match what the users have typed. For example, a text input field for
2107
+ # programming language might suggest Java, JavaScript, Python, and C++. When
2108
+ # users start typing "Jav", the list of suggestions filters to show just Java
2109
+ # and JavaScript. Suggested values help guide users to enter values that your
2110
+ # app can make sense of. When referring to JavaScript, some users might enter "
2111
+ # javascript" and others "java script". Suggesting "JavaScript" can standardize
2112
+ # how users interact with your app. When specified, `TextInput.type` is always `
2113
+ # SINGLE_LINE`, even if it is set to `MULTIPLE_LINE`.
1954
2114
  class GoogleAppsCardV1Suggestions
1955
2115
  include Google::Apis::Core::Hashable
1956
2116
 
1957
- # A list of suggestions used for autocomplete recommendations.
2117
+ # A list of suggestions used for autocomplete recommendations in text input
2118
+ # fields.
1958
2119
  # Corresponds to the JSON property `items`
1959
2120
  # @return [Array<Google::Apis::ChatV1::GoogleAppsCardV1SuggestionItem>]
1960
2121
  attr_accessor :items
@@ -1969,16 +2130,22 @@ module Google
1969
2130
  end
1970
2131
  end
1971
2132
 
1972
- # Either a toggle-style switch or a checkbox.
2133
+ # Either a toggle-style switch or a checkbox inside a `decoratedText` widget.
2134
+ # Only supported on the `decoratedText` widget. Currently supported in [dialogs](
2135
+ # https://developers.google.com/chat/how-tos/dialogs). Support for [card
2136
+ # messages](https://developers.google.com/chat/api/guides/message-formats/cards)
2137
+ # is coming soon.
1973
2138
  class GoogleAppsCardV1SwitchControl
1974
2139
  include Google::Apis::Core::Hashable
1975
2140
 
1976
- # The control type, either switch or checkbox.
2141
+ # How the switch appears in the user interface.
1977
2142
  # Corresponds to the JSON property `controlType`
1978
2143
  # @return [String]
1979
2144
  attr_accessor :control_type
1980
2145
 
1981
- # The name of the switch widget that's used in `formInput`.
2146
+ # The name by which the switch widget is identified in a form input event. For
2147
+ # details about working with form inputs, see [Receive form data](https://
2148
+ # developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
1982
2149
  # Corresponds to the JSON property `name`
1983
2150
  # @return [String]
1984
2151
  attr_accessor :name
@@ -1989,13 +2156,15 @@ module Google
1989
2156
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
1990
2157
  attr_accessor :on_change_action
1991
2158
 
1992
- # If the switch is selected.
2159
+ # When `true`, the switch is selected.
1993
2160
  # Corresponds to the JSON property `selected`
1994
2161
  # @return [Boolean]
1995
2162
  attr_accessor :selected
1996
2163
  alias_method :selected?, :selected
1997
2164
 
1998
- # The value is what is passed back in the callback.
2165
+ # The value entered by a user, returned as part of a form input event. For
2166
+ # details about working with form inputs, see [Receive form data](https://
2167
+ # developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
1999
2168
  # Corresponds to the JSON property `value`
2000
2169
  # @return [String]
2001
2170
  attr_accessor :value
@@ -2014,8 +2183,15 @@ module Google
2014
2183
  end
2015
2184
  end
2016
2185
 
2017
- # A text input is a UI item where users can input text. A text input can also
2018
- # have an onChange action and suggestions.
2186
+ # A field in which users can enter text. Supports suggestions and on-change
2187
+ # actions. Chat apps receive and can process the value of entered text during
2188
+ # form input events. For details about working with form inputs, see [Receive
2189
+ # form data](https://developers.google.com/chat/how-tos/dialogs#
2190
+ # receive_form_data_from_dialogs). When you need to collect abstract data from
2191
+ # users, use a text input. To collect defined data from users, use the selection
2192
+ # input widget instead. Only supported in [dialogs](https://developers.google.
2193
+ # com/chat/how-tos/dialogs). Support for [card messages](https://developers.
2194
+ # google.com/chat/api/guides/message-formats/cards) coming soon.
2019
2195
  class GoogleAppsCardV1TextInput
2020
2196
  include Google::Apis::Core::Hashable
2021
2197
 
@@ -2025,23 +2201,39 @@ module Google
2025
2201
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
2026
2202
  attr_accessor :auto_complete_action
2027
2203
 
2028
- # The hint text.
2204
+ # Text that appears inside the text input field meant to assist users by
2205
+ # prompting them to enter a certain value. This text is not visible after users
2206
+ # begin typing. Required if `label` is unspecified. Otherwise, optional.
2029
2207
  # Corresponds to the JSON property `hintText`
2030
2208
  # @return [String]
2031
2209
  attr_accessor :hint_text
2032
2210
 
2033
- # A container wrapping elements necessary for showing suggestion items used in
2034
- # text input autocomplete.
2211
+ # Suggested values that users can enter. These values appear when users click
2212
+ # inside the text input field. As users type, the suggested values dynamically
2213
+ # filter to match what the users have typed. For example, a text input field for
2214
+ # programming language might suggest Java, JavaScript, Python, and C++. When
2215
+ # users start typing "Jav", the list of suggestions filters to show just Java
2216
+ # and JavaScript. Suggested values help guide users to enter values that your
2217
+ # app can make sense of. When referring to JavaScript, some users might enter "
2218
+ # javascript" and others "java script". Suggesting "JavaScript" can standardize
2219
+ # how users interact with your app. When specified, `TextInput.type` is always `
2220
+ # SINGLE_LINE`, even if it is set to `MULTIPLE_LINE`.
2035
2221
  # Corresponds to the JSON property `initialSuggestions`
2036
2222
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Suggestions]
2037
2223
  attr_accessor :initial_suggestions
2038
2224
 
2039
- # At least one of label and hintText must be specified.
2225
+ # The text that appears above the text input field in the user interface.
2226
+ # Specify text that helps the user enter the information your app needs. For
2227
+ # example, if you are asking someone's name, but specifically need their surname,
2228
+ # write "surname" instead of "name". Required if `hintText` is unspecified.
2229
+ # Otherwise, optional.
2040
2230
  # Corresponds to the JSON property `label`
2041
2231
  # @return [String]
2042
2232
  attr_accessor :label
2043
2233
 
2044
- # The name of the text input which is used in `formInput`.
2234
+ # The name by which the text input is identified in a form input event. For
2235
+ # details about working with form inputs, see [Receive form data](https://
2236
+ # developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
2045
2237
  # Corresponds to the JSON property `name`
2046
2238
  # @return [String]
2047
2239
  attr_accessor :name
@@ -2052,12 +2244,15 @@ module Google
2052
2244
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
2053
2245
  attr_accessor :on_change_action
2054
2246
 
2055
- # The style of the text, for example, a single line or multiple lines.
2247
+ # How a text input field appears in the user interface. For example, whether the
2248
+ # field is single or multi-line.
2056
2249
  # Corresponds to the JSON property `type`
2057
2250
  # @return [String]
2058
2251
  attr_accessor :type
2059
2252
 
2060
- # The default value when there is no input from the user.
2253
+ # The value entered by a user, returned as part of a form input event. For
2254
+ # details about working with form inputs, see [Receive form data](https://
2255
+ # developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
2061
2256
  # Corresponds to the JSON property `value`
2062
2257
  # @return [String]
2063
2258
  attr_accessor :value
@@ -2100,7 +2295,8 @@ module Google
2100
2295
  end
2101
2296
  end
2102
2297
 
2103
- # A widget is a UI element that presents texts, images, etc.
2298
+ # Each card is made up of widgets. A widget is a composite object that can
2299
+ # represent one of text, images, buttons, and other object types.
2104
2300
  class GoogleAppsCardV1Widget
2105
2301
  include Google::Apis::Core::Hashable
2106
2302
 
@@ -2109,8 +2305,11 @@ module Google
2109
2305
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1ButtonList]
2110
2306
  attr_accessor :button_list
2111
2307
 
2112
- # The widget that lets users to specify a date and time. Not supported by Google
2113
- # Chat apps.
2308
+ # Lets users specify a date, a time, or both a date and a time. Accepts text
2309
+ # input from users, but features an interactive date and time selector that
2310
+ # helps users enter correctly-formatted dates and times. If users enter a date
2311
+ # or time incorrectly, the widget shows an error that prompts users to enter the
2312
+ # correct format. Not supported by Chat apps. Support by Chat apps coming soon.
2114
2313
  # Corresponds to the JSON property `dateTimePicker`
2115
2314
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1DateTimePicker]
2116
2315
  attr_accessor :date_time_picker
@@ -2122,34 +2321,57 @@ module Google
2122
2321
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1DecoratedText]
2123
2322
  attr_accessor :decorated_text
2124
2323
 
2125
- # A divider that appears in between widgets.
2324
+ # Displays a divider between widgets, a horizontal line. For example, the
2325
+ # following JSON creates a divider: ``` "divider": ` ` ```
2126
2326
  # Corresponds to the JSON property `divider`
2127
2327
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Divider]
2128
2328
  attr_accessor :divider
2129
2329
 
2130
- # Represents a Grid widget that displays items in a configurable grid layout.
2330
+ # Displays a grid with a collection of items. A grid supports any number of
2331
+ # columns and items. The number of rows is determined by items divided by
2332
+ # columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items
2333
+ # and 2 columns has 6 rows. Currently supported in [dialogs](https://developers.
2334
+ # google.com/chat/how-tos/dialogs). Support for [card messages](https://
2335
+ # developers.google.com/chat/api/guides/message-formats/cards) is coming soon.
2336
+ # For example, the following JSON creates a 2 column grid with a single item: ```
2337
+ # "grid": ` "title": "A fine collection of items", "numColumns": 2, "
2338
+ # borderStyle": ` "type": "STROKE", "cornerRadius": 4.0 `, "items": [ "image": `
2339
+ # "imageUri": "https://www.example.com/image.png", "cropStyle": ` "type": "
2340
+ # SQUARE" `, "borderStyle": ` "type": "STROKE" ` `, "title": "An item", "
2341
+ # textAlignment": "CENTER" ], "onClick": ` "openLink": ` "url":"https://www.
2342
+ # example.com" ` ` ` ```
2131
2343
  # Corresponds to the JSON property `grid`
2132
2344
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Grid]
2133
2345
  attr_accessor :grid
2134
2346
 
2135
- # The horizontal alignment of this widget.
2136
- # Corresponds to the JSON property `horizontalAlignment`
2137
- # @return [String]
2138
- attr_accessor :horizontal_alignment
2139
-
2140
2347
  # An image that is specified by a URL and can have an `onClick` action.
2141
2348
  # Corresponds to the JSON property `image`
2142
2349
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1Image]
2143
2350
  attr_accessor :image
2144
2351
 
2145
2352
  # A widget that creates a UI item with options for users to select. For example,
2146
- # a dropdown menu.
2353
+ # a dropdown menu or check list. Chat apps receive and can process the value of
2354
+ # entered text during form input events. For details about working with form
2355
+ # inputs, see [Receive form data](https://developers.google.com/chat/how-tos/
2356
+ # dialogs#receive_form_data_from_dialogs). When you need to collect data from
2357
+ # users that matches options you set, use a selection input. To collect abstract
2358
+ # data from users, use the text input widget instead. Only supported in [dialogs]
2359
+ # (https://developers.google.com/chat/how-tos/dialogs). Support for [card
2360
+ # messages](https://developers.google.com/chat/api/guides/message-formats/cards)
2361
+ # coming soon.
2147
2362
  # Corresponds to the JSON property `selectionInput`
2148
2363
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput]
2149
2364
  attr_accessor :selection_input
2150
2365
 
2151
- # A text input is a UI item where users can input text. A text input can also
2152
- # have an onChange action and suggestions.
2366
+ # A field in which users can enter text. Supports suggestions and on-change
2367
+ # actions. Chat apps receive and can process the value of entered text during
2368
+ # form input events. For details about working with form inputs, see [Receive
2369
+ # form data](https://developers.google.com/chat/how-tos/dialogs#
2370
+ # receive_form_data_from_dialogs). When you need to collect abstract data from
2371
+ # users, use a text input. To collect defined data from users, use the selection
2372
+ # input widget instead. Only supported in [dialogs](https://developers.google.
2373
+ # com/chat/how-tos/dialogs). Support for [card messages](https://developers.
2374
+ # google.com/chat/api/guides/message-formats/cards) coming soon.
2153
2375
  # Corresponds to the JSON property `textInput`
2154
2376
  # @return [Google::Apis::ChatV1::GoogleAppsCardV1TextInput]
2155
2377
  attr_accessor :text_input
@@ -2172,7 +2394,6 @@ module Google
2172
2394
  @decorated_text = args[:decorated_text] if args.key?(:decorated_text)
2173
2395
  @divider = args[:divider] if args.key?(:divider)
2174
2396
  @grid = args[:grid] if args.key?(:grid)
2175
- @horizontal_alignment = args[:horizontal_alignment] if args.key?(:horizontal_alignment)
2176
2397
  @image = args[:image] if args.key?(:image)
2177
2398
  @selection_input = args[:selection_input] if args.key?(:selection_input)
2178
2399
  @text_input = args[:text_input] if args.key?(:text_input)
@@ -2364,8 +2585,8 @@ module Google
2364
2585
  # @return [Array<Google::Apis::ChatV1::Membership>]
2365
2586
  attr_accessor :memberships
2366
2587
 
2367
- # Continuation token to retrieve the next page of results. It will be empty for
2368
- # the last page of results.
2588
+ # A token that can be sent as `pageToken` to retrieve the next page of results.
2589
+ # If empty, there are no subsequent pages.
2369
2590
  # Corresponds to the JSON property `nextPageToken`
2370
2591
  # @return [String]
2371
2592
  attr_accessor :next_page_token
@@ -2385,9 +2606,8 @@ module Google
2385
2606
  class ListSpacesResponse
2386
2607
  include Google::Apis::Core::Hashable
2387
2608
 
2388
- # Continuation token to retrieve the next page of results. It will be empty for
2389
- # the last page of results. Tokens expire in an hour. An error is thrown if an
2390
- # expired token is passed.
2609
+ # A token that can be sent as `pageToken` to retrieve the next page of results.
2610
+ # If empty, there are no subsequent pages.
2391
2611
  # Corresponds to the JSON property `nextPageToken`
2392
2612
  # @return [String]
2393
2613
  attr_accessor :next_page_token
@@ -2518,9 +2738,10 @@ module Google
2518
2738
  # @return [Array<Google::Apis::ChatV1::Attachment>]
2519
2739
  attr_accessor :attachment
2520
2740
 
2521
- # Rich, formatted and interactive cards that can be used to display UI elements
2522
- # such as: formatted texts, buttons, clickable images. Cards are normally
2523
- # displayed below the plain-text body of the message.
2741
+ # Deprecated: Use `cards_v2` instead. Rich, formatted and interactive cards that
2742
+ # can be used to display UI elements such as: formatted texts, buttons,
2743
+ # clickable images. Cards are normally displayed below the plain-text body of
2744
+ # the message.
2524
2745
  # Corresponds to the JSON property `cards`
2525
2746
  # @return [Array<Google::Apis::ChatV1::Card>]
2526
2747
  attr_accessor :cards
@@ -2532,11 +2753,20 @@ module Google
2532
2753
  # (https://developers.google.com/chat/how-tos/dialogs). The `cardId` is a unique
2533
2754
  # identifier among cards in the same message and for identifying user input
2534
2755
  # values. Currently supported widgets include: - `TextParagraph` - `
2535
- # DecoratedText` - `Image` - `ButtonList`
2756
+ # DecoratedText` - `Image` - `ButtonList` - `Divider`
2536
2757
  # Corresponds to the JSON property `cardsV2`
2537
2758
  # @return [Array<Google::Apis::ChatV1::CardWithId>]
2538
2759
  attr_accessor :cards_v2
2539
2760
 
2761
+ # A custom name for a Chat message assigned at creation. Must start with `client-
2762
+ # ` and contain only lowercase letters, numbers, and hyphens up to 63 characters
2763
+ # in length. Specify this field to get, update, or delete the message with the
2764
+ # specified value. For example usage, see [Name a created message](https://
2765
+ # developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).
2766
+ # Corresponds to the JSON property `clientAssignedMessageId`
2767
+ # @return [String]
2768
+ attr_accessor :client_assigned_message_id
2769
+
2540
2770
  # Output only. The time at which the message was created in Google Chat server.
2541
2771
  # Corresponds to the JSON property `createTime`
2542
2772
  # @return [String]
@@ -2595,6 +2825,15 @@ module Google
2595
2825
  # @return [Google::Apis::ChatV1::Thread]
2596
2826
  attr_accessor :thread
2597
2827
 
2828
+ # Output only. When `true`, the message is a response in a reply thread. When `
2829
+ # false`, the message is visible in the space's top-level conversation as either
2830
+ # the first message of a thread or a message with no threaded replies. If the
2831
+ # space doesn't support reply in threads, this field is always `false`.
2832
+ # Corresponds to the JSON property `threadReply`
2833
+ # @return [Boolean]
2834
+ attr_accessor :thread_reply
2835
+ alias_method :thread_reply?, :thread_reply
2836
+
2598
2837
  def initialize(**args)
2599
2838
  update!(**args)
2600
2839
  end
@@ -2607,6 +2846,7 @@ module Google
2607
2846
  @attachment = args[:attachment] if args.key?(:attachment)
2608
2847
  @cards = args[:cards] if args.key?(:cards)
2609
2848
  @cards_v2 = args[:cards_v2] if args.key?(:cards_v2)
2849
+ @client_assigned_message_id = args[:client_assigned_message_id] if args.key?(:client_assigned_message_id)
2610
2850
  @create_time = args[:create_time] if args.key?(:create_time)
2611
2851
  @fallback_text = args[:fallback_text] if args.key?(:fallback_text)
2612
2852
  @last_update_time = args[:last_update_time] if args.key?(:last_update_time)
@@ -2617,6 +2857,7 @@ module Google
2617
2857
  @space = args[:space] if args.key?(:space)
2618
2858
  @text = args[:text] if args.key?(:text)
2619
2859
  @thread = args[:thread] if args.key?(:thread)
2860
+ @thread_reply = args[:thread_reply] if args.key?(:thread_reply)
2620
2861
  end
2621
2862
  end
2622
2863
 
@@ -2783,7 +3024,13 @@ module Google
2783
3024
  # @return [Google::Apis::ChatV1::SpaceDetails]
2784
3025
  attr_accessor :space_details
2785
3026
 
2786
- # Output only. Whether messages are threaded in this space.
3027
+ # Output only. The threading state in the Chat space.
3028
+ # Corresponds to the JSON property `spaceThreadingState`
3029
+ # @return [String]
3030
+ attr_accessor :space_threading_state
3031
+
3032
+ # Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages
3033
+ # are threaded in this space.
2787
3034
  # Corresponds to the JSON property `threaded`
2788
3035
  # @return [Boolean]
2789
3036
  attr_accessor :threaded
@@ -2805,6 +3052,7 @@ module Google
2805
3052
  @name = args[:name] if args.key?(:name)
2806
3053
  @single_user_bot_dm = args[:single_user_bot_dm] if args.key?(:single_user_bot_dm)
2807
3054
  @space_details = args[:space_details] if args.key?(:space_details)
3055
+ @space_threading_state = args[:space_threading_state] if args.key?(:space_threading_state)
2808
3056
  @threaded = args[:threaded] if args.key?(:threaded)
2809
3057
  @type = args[:type] if args.key?(:type)
2810
3058
  end
@@ -2944,12 +3192,20 @@ module Google
2944
3192
  class Thread
2945
3193
  include Google::Apis::Core::Hashable
2946
3194
 
2947
- # Resource name, in the form "spaces/*/threads/*". Example: spaces/AAAAAAAAAAA/
2948
- # threads/TTTTTTTTTTT
3195
+ # Resource name of the thread. Example: spaces/`space`/threads/`thread`
2949
3196
  # Corresponds to the JSON property `name`
2950
3197
  # @return [String]
2951
3198
  attr_accessor :name
2952
3199
 
3200
+ # Optional. Opaque thread identifier. To start or add to a thread, create a
3201
+ # message and specify a `threadKey` or the thread.name. For example usage, see [
3202
+ # Start or reply to a message thread](/chat/api/guides/crudl/messages#
3203
+ # start_or_reply_to_a_message_thread). For other requests, this is an output
3204
+ # only field.
3205
+ # Corresponds to the JSON property `threadKey`
3206
+ # @return [String]
3207
+ attr_accessor :thread_key
3208
+
2953
3209
  def initialize(**args)
2954
3210
  update!(**args)
2955
3211
  end
@@ -2957,6 +3213,7 @@ module Google
2957
3213
  # Update properties of this object
2958
3214
  def update!(**args)
2959
3215
  @name = args[:name] if args.key?(:name)
3216
+ @thread_key = args[:thread_key] if args.key?(:thread_key)
2960
3217
  end
2961
3218
  end
2962
3219
 
@@ -3033,10 +3290,8 @@ module Google
3033
3290
  attr_accessor :is_anonymous
3034
3291
  alias_method :is_anonymous?, :is_anonymous
3035
3292
 
3036
- # Resource name for a Google Chat user. Represents a [person](https://developers.
3037
- # google.com/people/api/rest/v1/people#Person) in the People API or a [user](
3038
- # https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in
3039
- # the Admin SDK Directory API. Formatted as: `users/`user``
3293
+ # Resource name for a Google Chat user. For human users, represents a person in
3294
+ # the People API or a user in the Admin SDK Directory API. Format: `users/`user``
3040
3295
  # Corresponds to the JSON property `name`
3041
3296
  # @return [String]
3042
3297
  attr_accessor :name