google-apps-chat-v1 0.5.1 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -303,8 +303,28 @@ module Google
303
303
  universe_domain: @config.universe_domain,
304
304
  channel_args: @config.channel_args,
305
305
  interceptors: @config.interceptors,
306
- channel_pool_config: @config.channel_pool
306
+ channel_pool_config: @config.channel_pool,
307
+ logger: @config.logger
307
308
  )
309
+
310
+ @chat_service_stub.stub_logger&.info do |entry|
311
+ entry.set_system_name
312
+ entry.set_service
313
+ entry.message = "Created client for #{entry.service}"
314
+ entry.set_credentials_fields credentials
315
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
316
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
317
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
318
+ end
319
+ end
320
+
321
+ ##
322
+ # The logger used for request/response debug logging.
323
+ #
324
+ # @return [Logger]
325
+ #
326
+ def logger
327
+ @chat_service_stub.logger
308
328
  end
309
329
 
310
330
  # Service calls
@@ -313,8 +333,11 @@ module Google
313
333
  # Creates a message in a Google Chat space. For an example, see [Send a
314
334
  # message](https://developers.google.com/workspace/chat/create-messages).
315
335
  #
316
- # The `create()` method requires either user or app authentication. Chat
317
- # attributes the message sender differently depending on the type of
336
+ # The `create()` method requires either [user
337
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
338
+ # or [app
339
+ # authentication](https://developers.google.com/workspace/chat/authorize-import).
340
+ # Chat attributes the message sender differently depending on the type of
318
341
  # authentication that you use in your request.
319
342
  #
320
343
  # The following image shows how Chat attributes a message when you use app
@@ -335,6 +358,12 @@ module Google
335
358
  #
336
359
  # The maximum message size, including the message contents, is 32,000 bytes.
337
360
  #
361
+ # For
362
+ # [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks)
363
+ # requests, the response doesn't contain the full message. The response only
364
+ # populates the `name` and `thread.name` fields in addition to the
365
+ # information that was in the request.
366
+ #
338
367
  # @overload create_message(request, options = nil)
339
368
  # Pass arguments to `create_message` via a request object, either of type
340
369
  # {::Google::Apps::Chat::V1::CreateMessageRequest} or an equivalent Hash.
@@ -371,6 +400,12 @@ module Google
371
400
  # @param message_reply_option [::Google::Apps::Chat::V1::CreateMessageRequest::MessageReplyOption]
372
401
  # Optional. Specifies whether a message starts a thread or replies to one.
373
402
  # Only supported in named spaces.
403
+ #
404
+ # When [responding to user
405
+ # interactions](https://developers.google.com/workspace/chat/receive-respond-interactions),
406
+ # this field is ignored. For interactions within a thread, the reply is
407
+ # created in the same thread. Otherwise, the reply is created as a new
408
+ # thread.
374
409
  # @param message_id [::String]
375
410
  # Optional. A custom ID for a message. Lets Chat apps get, update, or delete
376
411
  # a message without needing to store the system-assigned ID in the message's
@@ -447,7 +482,6 @@ module Google
447
482
 
448
483
  @chat_service_stub.call_rpc :create_message, request, options: options do |response, operation|
449
484
  yield response, operation if block_given?
450
- return response
451
485
  end
452
486
  rescue ::GRPC::BadStatus => e
453
487
  raise ::Google::Cloud::Error.from_error(e)
@@ -461,6 +495,7 @@ module Google
461
495
  # For an example, see
462
496
  # [List
463
497
  # messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
498
+ #
464
499
  # Requires [user
465
500
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
466
501
  #
@@ -484,8 +519,8 @@ module Google
484
519
  #
485
520
  # Format: `spaces/{space}`
486
521
  # @param page_size [::Integer]
487
- # The maximum number of messages returned. The service might return fewer
488
- # messages than this value.
522
+ # Optional. The maximum number of messages returned. The service might return
523
+ # fewer messages than this value.
489
524
  #
490
525
  # If unspecified, at most 25 are returned.
491
526
  #
@@ -494,16 +529,14 @@ module Google
494
529
  #
495
530
  # Negative values return an `INVALID_ARGUMENT` error.
496
531
  # @param page_token [::String]
497
- # Optional, if resuming from a previous query.
498
- #
499
- # A page token received from a previous list messages call. Provide this
500
- # parameter to retrieve the subsequent page.
532
+ # Optional. A page token received from a previous list messages call. Provide
533
+ # this parameter to retrieve the subsequent page.
501
534
  #
502
535
  # When paginating, all other parameters provided should match the call that
503
536
  # provided the page token. Passing different values to the other parameters
504
537
  # might lead to unexpected results.
505
538
  # @param filter [::String]
506
- # A query filter.
539
+ # Optional. A query filter.
507
540
  #
508
541
  # You can filter messages by date (`create_time`) and thread (`thread.name`).
509
542
  #
@@ -541,10 +574,8 @@ module Google
541
574
  # Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
542
575
  # error.
543
576
  # @param order_by [::String]
544
- # Optional, if resuming from a previous query.
545
- #
546
- # How the list of messages is ordered. Specify a value to order by an
547
- # ordering operation. Valid ordering operation values are as follows:
577
+ # Optional. How the list of messages is ordered. Specify a value to order by
578
+ # an ordering operation. Valid ordering operation values are as follows:
548
579
  #
549
580
  # - `ASC` for ascending.
550
581
  #
@@ -552,8 +583,9 @@ module Google
552
583
  #
553
584
  # The default ordering is `create_time ASC`.
554
585
  # @param show_deleted [::Boolean]
555
- # Whether to include deleted messages. Deleted messages include deleted time
556
- # and metadata about their deletion, but message content is unavailable.
586
+ # Optional. Whether to include deleted messages. Deleted messages include
587
+ # deleted time and metadata about their deletion, but message content is
588
+ # unavailable.
557
589
  #
558
590
  # @yield [response, operation] Access the result along with the RPC operation
559
591
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Apps::Chat::V1::Message>]
@@ -619,7 +651,7 @@ module Google
619
651
  @chat_service_stub.call_rpc :list_messages, request, options: options do |response, operation|
620
652
  response = ::Gapic::PagedEnumerable.new @chat_service_stub, :list_messages, request, response, operation, options
621
653
  yield response, operation if block_given?
622
- return response
654
+ throw :response, response
623
655
  end
624
656
  rescue ::GRPC::BadStatus => e
625
657
  raise ::Google::Cloud::Error.from_error(e)
@@ -638,13 +670,16 @@ module Google
638
670
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
639
671
  # lists memberships in spaces that the authenticated user has access to.
640
672
  #
641
- # Requires
642
- # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
643
- # Supports
644
- # [app
673
+ # Supports the following types of
674
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
675
+ #
676
+ # - [App
645
677
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
646
- # and [user
647
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
678
+ #
679
+ # - [User
680
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
681
+ # You can authenticate and authorize this method with administrator
682
+ # privileges by setting the `use_admin_access` field in the request.
648
683
  #
649
684
  # @overload list_memberships(request, options = nil)
650
685
  # Pass arguments to `list_memberships` via a request object, either of type
@@ -739,7 +774,7 @@ module Google
739
774
  # Currently requires [user
740
775
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
741
776
  # @param use_admin_access [::Boolean]
742
- # When `true`, the method runs using the user's Google Workspace
777
+ # Optional. When `true`, the method runs using the user's Google Workspace
743
778
  # administrator privileges.
744
779
  #
745
780
  # The calling user must be a Google Workspace administrator with the
@@ -816,7 +851,7 @@ module Google
816
851
  @chat_service_stub.call_rpc :list_memberships, request, options: options do |response, operation|
817
852
  response = ::Gapic::PagedEnumerable.new @chat_service_stub, :list_memberships, request, response, operation, options
818
853
  yield response, operation if block_given?
819
- return response
854
+ throw :response, response
820
855
  end
821
856
  rescue ::GRPC::BadStatus => e
822
857
  raise ::Google::Cloud::Error.from_error(e)
@@ -827,13 +862,16 @@ module Google
827
862
  # [Get details about a user's or Google Chat app's
828
863
  # membership](https://developers.google.com/workspace/chat/get-members).
829
864
  #
830
- # Requires
831
- # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
832
- # Supports
833
- # [app
865
+ # Supports the following types of
866
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
867
+ #
868
+ # - [App
834
869
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
835
- # and [user
836
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
870
+ #
871
+ # - [User
872
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
873
+ # You can authenticate and authorize this method with administrator
874
+ # privileges by setting the `use_admin_access` field in the request.
837
875
  #
838
876
  # @overload get_membership(request, options = nil)
839
877
  # Pass arguments to `get_membership` via a request object, either of type
@@ -859,13 +897,11 @@ module Google
859
897
  #
860
898
  # Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`
861
899
  #
862
- # When [authenticated as a
863
- # user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
864
- # you can use the user's email as an alias for `{member}`. For example,
900
+ # You can use the user's email as an alias for `{member}`. For example,
865
901
  # `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the
866
902
  # email of the Google Chat user.
867
903
  # @param use_admin_access [::Boolean]
868
- # When `true`, the method runs using the user's Google Workspace
904
+ # Optional. When `true`, the method runs using the user's Google Workspace
869
905
  # administrator privileges.
870
906
  #
871
907
  # The calling user must be a Google Workspace administrator with the
@@ -937,7 +973,6 @@ module Google
937
973
 
938
974
  @chat_service_stub.call_rpc :get_membership, request, options: options do |response, operation|
939
975
  yield response, operation if block_given?
940
- return response
941
976
  end
942
977
  rescue ::GRPC::BadStatus => e
943
978
  raise ::Google::Cloud::Error.from_error(e)
@@ -948,13 +983,14 @@ module Google
948
983
  # For an example, see [Get details about a
949
984
  # message](https://developers.google.com/workspace/chat/get-messages).
950
985
  #
951
- # Requires
952
- # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
953
- # Supports
954
- # [app
986
+ # Supports the following types of
987
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
988
+ #
989
+ # - [App
955
990
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
956
- # and [user
957
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
991
+ #
992
+ # - [User
993
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
958
994
  #
959
995
  # Note: Might return a message from a blocked member or space.
960
996
  #
@@ -1042,7 +1078,6 @@ module Google
1042
1078
 
1043
1079
  @chat_service_stub.call_rpc :get_message, request, options: options do |response, operation|
1044
1080
  yield response, operation if block_given?
1045
- return response
1046
1081
  end
1047
1082
  rescue ::GRPC::BadStatus => e
1048
1083
  raise ::Google::Cloud::Error.from_error(e)
@@ -1056,13 +1091,15 @@ module Google
1056
1091
  # [Update a
1057
1092
  # message](https://developers.google.com/workspace/chat/update-messages).
1058
1093
  #
1059
- # Requires
1060
- # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
1061
- # Supports
1062
- # [app
1094
+ # Supports the following types of
1095
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
1096
+ #
1097
+ # - [App
1063
1098
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1064
- # and [user
1065
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1099
+ #
1100
+ # - [User
1101
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1102
+ #
1066
1103
  # When using app authentication, requests can only update messages
1067
1104
  # created by the calling Chat app.
1068
1105
  #
@@ -1166,7 +1203,6 @@ module Google
1166
1203
 
1167
1204
  @chat_service_stub.call_rpc :update_message, request, options: options do |response, operation|
1168
1205
  yield response, operation if block_given?
1169
- return response
1170
1206
  end
1171
1207
  rescue ::GRPC::BadStatus => e
1172
1208
  raise ::Google::Cloud::Error.from_error(e)
@@ -1177,13 +1213,15 @@ module Google
1177
1213
  # For an example, see [Delete a
1178
1214
  # message](https://developers.google.com/workspace/chat/delete-messages).
1179
1215
  #
1180
- # Requires
1181
- # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
1182
- # Supports
1183
- # [app
1216
+ # Supports the following types of
1217
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
1218
+ #
1219
+ # - [App
1184
1220
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1185
- # and [user
1186
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1221
+ #
1222
+ # - [User
1223
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1224
+ #
1187
1225
  # When using app authentication, requests can only delete messages
1188
1226
  # created by the calling Chat app.
1189
1227
  #
@@ -1212,8 +1250,8 @@ module Google
1212
1250
  # message]
1213
1251
  # (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
1214
1252
  # @param force [::Boolean]
1215
- # When `true`, deleting a message also deletes its threaded replies. When
1216
- # `false`, if a message has threaded replies, deletion fails.
1253
+ # Optional. When `true`, deleting a message also deletes its threaded
1254
+ # replies. When `false`, if a message has threaded replies, deletion fails.
1217
1255
  #
1218
1256
  # Only applies when [authenticating as a
1219
1257
  # user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -1279,7 +1317,6 @@ module Google
1279
1317
 
1280
1318
  @chat_service_stub.call_rpc :delete_message, request, options: options do |response, operation|
1281
1319
  yield response, operation if block_given?
1282
- return response
1283
1320
  end
1284
1321
  rescue ::GRPC::BadStatus => e
1285
1322
  raise ::Google::Cloud::Error.from_error(e)
@@ -1373,7 +1410,6 @@ module Google
1373
1410
 
1374
1411
  @chat_service_stub.call_rpc :get_attachment, request, options: options do |response, operation|
1375
1412
  yield response, operation if block_given?
1376
- return response
1377
1413
  end
1378
1414
  rescue ::GRPC::BadStatus => e
1379
1415
  raise ::Google::Cloud::Error.from_error(e)
@@ -1383,6 +1419,7 @@ module Google
1383
1419
  # Uploads an attachment. For an example, see
1384
1420
  # [Upload media as a file
1385
1421
  # attachment](https://developers.google.com/workspace/chat/upload-media-attachments).
1422
+ #
1386
1423
  # Requires user
1387
1424
  # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1388
1425
  #
@@ -1470,7 +1507,6 @@ module Google
1470
1507
 
1471
1508
  @chat_service_stub.call_rpc :upload_attachment, request, options: options do |response, operation|
1472
1509
  yield response, operation if block_given?
1473
- return response
1474
1510
  end
1475
1511
  rescue ::GRPC::BadStatus => e
1476
1512
  raise ::Google::Cloud::Error.from_error(e)
@@ -1482,16 +1518,14 @@ module Google
1482
1518
  # [List
1483
1519
  # spaces](https://developers.google.com/workspace/chat/list-spaces).
1484
1520
  #
1485
- # Requires
1486
- # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
1487
- # Supports
1488
- # [app
1521
+ # Supports the following types of
1522
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
1523
+ #
1524
+ # - [App
1489
1525
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1490
- # and [user
1491
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1492
1526
  #
1493
- # Lists spaces visible to the caller or authenticated user. Group chats
1494
- # and DMs aren't listed until the first message is sent.
1527
+ # - [User
1528
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1495
1529
  #
1496
1530
  # To list all named spaces by Google Workspace organization, use the
1497
1531
  # [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)
@@ -1605,7 +1639,7 @@ module Google
1605
1639
  @chat_service_stub.call_rpc :list_spaces, request, options: options do |response, operation|
1606
1640
  response = ::Gapic::PagedEnumerable.new @chat_service_stub, :list_spaces, request, response, operation, options
1607
1641
  yield response, operation if block_given?
1608
- return response
1642
+ throw :response, response
1609
1643
  end
1610
1644
  rescue ::GRPC::BadStatus => e
1611
1645
  raise ::Google::Cloud::Error.from_error(e)
@@ -1613,7 +1647,9 @@ module Google
1613
1647
 
1614
1648
  ##
1615
1649
  # Returns a list of spaces in a Google Workspace organization based on an
1616
- # administrator's search. Requires [user
1650
+ # administrator's search.
1651
+ #
1652
+ # Requires [user
1617
1653
  # authentication with administrator
1618
1654
  # privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges).
1619
1655
  # In the request, set `use_admin_access` to `true`.
@@ -1813,7 +1849,7 @@ module Google
1813
1849
  @chat_service_stub.call_rpc :search_spaces, request, options: options do |response, operation|
1814
1850
  response = ::Gapic::PagedEnumerable.new @chat_service_stub, :search_spaces, request, response, operation, options
1815
1851
  yield response, operation if block_given?
1816
- return response
1852
+ throw :response, response
1817
1853
  end
1818
1854
  rescue ::GRPC::BadStatus => e
1819
1855
  raise ::Google::Cloud::Error.from_error(e)
@@ -1824,13 +1860,16 @@ module Google
1824
1860
  # [Get details about a
1825
1861
  # space](https://developers.google.com/workspace/chat/get-spaces).
1826
1862
  #
1827
- # Requires
1828
- # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
1829
- # Supports
1830
- # [app
1863
+ # Supports the following types of
1864
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
1865
+ #
1866
+ # - [App
1831
1867
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1832
- # and [user
1833
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1868
+ #
1869
+ # - [User
1870
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1871
+ # You can authenticate and authorize this method with administrator
1872
+ # privileges by setting the `use_admin_access` field in the request.
1834
1873
  #
1835
1874
  # @overload get_space(request, options = nil)
1836
1875
  # Pass arguments to `get_space` via a request object, either of type
@@ -1852,7 +1891,7 @@ module Google
1852
1891
  #
1853
1892
  # Format: `spaces/{space}`
1854
1893
  # @param use_admin_access [::Boolean]
1855
- # When `true`, the method runs using the user's Google Workspace
1894
+ # Optional. When `true`, the method runs using the user's Google Workspace
1856
1895
  # administrator privileges.
1857
1896
  #
1858
1897
  # The calling user must be a Google Workspace administrator with the
@@ -1921,28 +1960,33 @@ module Google
1921
1960
 
1922
1961
  @chat_service_stub.call_rpc :get_space, request, options: options do |response, operation|
1923
1962
  yield response, operation if block_given?
1924
- return response
1925
1963
  end
1926
1964
  rescue ::GRPC::BadStatus => e
1927
1965
  raise ::Google::Cloud::Error.from_error(e)
1928
1966
  end
1929
1967
 
1930
1968
  ##
1931
- # Creates a space with no members. Can be used to create a named space.
1932
- # Spaces grouped by topics aren't supported. For an example, see
1933
- # [Create a
1969
+ # Creates a space with no members. Can be used to create a named space, or a
1970
+ # group chat in `Import mode`. For an example, see [Create a
1934
1971
  # space](https://developers.google.com/workspace/chat/create-spaces).
1935
1972
  #
1936
1973
  # If you receive the error message `ALREADY_EXISTS` when creating
1937
1974
  # a space, try a different `displayName`. An existing space within
1938
1975
  # the Google Workspace organization might already use this display name.
1939
1976
  #
1940
- # If you're a member of the [Developer Preview
1941
- # program](https://developers.google.com/workspace/preview), you can create a
1942
- # group chat in import mode using `spaceType.GROUP_CHAT`.
1977
+ # Supports the following types of
1978
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
1943
1979
  #
1944
- # Requires [user
1945
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1980
+ # - [App
1981
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1982
+ # with [administrator approval](https://support.google.com/a?p=chat-app-auth)
1983
+ # in [Developer Preview](https://developers.google.com/workspace/preview)
1984
+ #
1985
+ # - [User
1986
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1987
+ #
1988
+ # When authenticating as an app, the `space.customer` field must be set in
1989
+ # the request.
1946
1990
  #
1947
1991
  # @overload create_space(request, options = nil)
1948
1992
  # Pass arguments to `create_space` via a request object, either of type
@@ -1961,15 +2005,13 @@ module Google
1961
2005
  #
1962
2006
  # @param space [::Google::Apps::Chat::V1::Space, ::Hash]
1963
2007
  # Required. The `displayName` and `spaceType` fields must be populated. Only
1964
- # `SpaceType.SPACE` is supported.
2008
+ # `SpaceType.SPACE` and `SpaceType.GROUP_CHAT` are supported.
2009
+ # `SpaceType.GROUP_CHAT` can only be used if `importMode` is set to true.
1965
2010
  #
1966
2011
  # If you receive the error message `ALREADY_EXISTS`,
1967
2012
  # try a different `displayName`. An existing space within the Google
1968
2013
  # Workspace organization might already use this display name.
1969
2014
  #
1970
- # If you're a member of the [Developer Preview
1971
- # program](https://developers.google.com/workspace/preview),
1972
- # `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true.
1973
2015
  #
1974
2016
  # The space `name` is assigned on the server so anything specified in this
1975
2017
  # field will be ignored.
@@ -2032,7 +2074,6 @@ module Google
2032
2074
 
2033
2075
  @chat_service_stub.call_rpc :create_space, request, options: options do |response, operation|
2034
2076
  yield response, operation if block_given?
2035
- return response
2036
2077
  end
2037
2078
  rescue ::GRPC::BadStatus => e
2038
2079
  raise ::Google::Cloud::Error.from_error(e)
@@ -2220,7 +2261,6 @@ module Google
2220
2261
 
2221
2262
  @chat_service_stub.call_rpc :set_up_space, request, options: options do |response, operation|
2222
2263
  yield response, operation if block_given?
2223
- return response
2224
2264
  end
2225
2265
  rescue ::GRPC::BadStatus => e
2226
2266
  raise ::Google::Cloud::Error.from_error(e)
@@ -2235,8 +2275,18 @@ module Google
2235
2275
  # `ALREADY_EXISTS`, try a different display name.. An existing space within
2236
2276
  # the Google Workspace organization might already use this display name.
2237
2277
  #
2238
- # Requires [user
2239
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
2278
+ # Supports the following types of
2279
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
2280
+ #
2281
+ # - [App
2282
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
2283
+ # with [administrator approval](https://support.google.com/a?p=chat-app-auth)
2284
+ # in [Developer Preview](https://developers.google.com/workspace/preview)
2285
+ #
2286
+ # - [User
2287
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
2288
+ # You can authenticate and authorize this method with administrator
2289
+ # privileges by setting the `use_admin_access` field in the request.
2240
2290
  #
2241
2291
  # @overload update_space(request, options = nil)
2242
2292
  # Pass arguments to `update_space` via a request object, either of type
@@ -2320,7 +2370,7 @@ module Google
2320
2370
  # - `permission_settings.manageWebhooks`
2321
2371
  # - `permission_settings.replyMessages`
2322
2372
  # @param use_admin_access [::Boolean]
2323
- # When `true`, the method runs using the user's Google Workspace
2373
+ # Optional. When `true`, the method runs using the user's Google Workspace
2324
2374
  # administrator privileges.
2325
2375
  #
2326
2376
  # The calling user must be a Google Workspace administrator with the
@@ -2392,7 +2442,6 @@ module Google
2392
2442
 
2393
2443
  @chat_service_stub.call_rpc :update_space, request, options: options do |response, operation|
2394
2444
  yield response, operation if block_given?
2395
- return response
2396
2445
  end
2397
2446
  rescue ::GRPC::BadStatus => e
2398
2447
  raise ::Google::Cloud::Error.from_error(e)
@@ -2404,9 +2453,19 @@ module Google
2404
2453
  # memberships in the space—are also deleted. For an example, see
2405
2454
  # [Delete a
2406
2455
  # space](https://developers.google.com/workspace/chat/delete-spaces).
2407
- # Requires [user
2456
+ #
2457
+ # Supports the following types of
2458
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
2459
+ #
2460
+ # - [App
2461
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
2462
+ # with [administrator approval](https://support.google.com/a?p=chat-app-auth)
2463
+ # in [Developer Preview](https://developers.google.com/workspace/preview)
2464
+ #
2465
+ # - [User
2408
2466
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
2409
- # from a user who has permission to delete the space.
2467
+ # You can authenticate and authorize this method with administrator
2468
+ # privileges by setting the `use_admin_access` field in the request.
2410
2469
  #
2411
2470
  # @overload delete_space(request, options = nil)
2412
2471
  # Pass arguments to `delete_space` via a request object, either of type
@@ -2428,7 +2487,7 @@ module Google
2428
2487
  #
2429
2488
  # Format: `spaces/{space}`
2430
2489
  # @param use_admin_access [::Boolean]
2431
- # When `true`, the method runs using the user's Google Workspace
2490
+ # Optional. When `true`, the method runs using the user's Google Workspace
2432
2491
  # administrator privileges.
2433
2492
  #
2434
2493
  # The calling user must be a Google Workspace administrator with the
@@ -2497,7 +2556,6 @@ module Google
2497
2556
 
2498
2557
  @chat_service_stub.call_rpc :delete_space, request, options: options do |response, operation|
2499
2558
  yield response, operation if block_given?
2500
- return response
2501
2559
  end
2502
2560
  rescue ::GRPC::BadStatus => e
2503
2561
  raise ::Google::Cloud::Error.from_error(e)
@@ -2507,8 +2565,11 @@ module Google
2507
2565
  # Completes the
2508
2566
  # [import process](https://developers.google.com/workspace/chat/import-data)
2509
2567
  # for the specified space and makes it visible to users.
2510
- # Requires app authentication and domain-wide delegation. For more
2511
- # information, see [Authorize Google Chat apps to import
2568
+ #
2569
+ # Requires [app
2570
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
2571
+ # and domain-wide delegation. For more information, see [Authorize Google
2572
+ # Chat apps to import
2512
2573
  # data](https://developers.google.com/workspace/chat/authorize-import).
2513
2574
  #
2514
2575
  # @overload complete_import_space(request, options = nil)
@@ -2590,7 +2651,6 @@ module Google
2590
2651
 
2591
2652
  @chat_service_stub.call_rpc :complete_import_space, request, options: options do |response, operation|
2592
2653
  yield response, operation if block_given?
2593
- return response
2594
2654
  end
2595
2655
  rescue ::GRPC::BadStatus => e
2596
2656
  raise ::Google::Cloud::Error.from_error(e)
@@ -2602,20 +2662,24 @@ module Google
2602
2662
  # see
2603
2663
  # [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message).
2604
2664
  #
2665
+ # With [app
2666
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
2667
+ # returns the direct message space between the specified user and the calling
2668
+ # Chat app.
2669
+ #
2605
2670
  # With [user
2606
2671
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
2607
2672
  # returns the direct message space between the specified user and the
2608
2673
  # authenticated user.
2609
2674
  #
2610
- # With [app
2611
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
2612
- # returns the direct message space between the specified user and the calling
2613
- # Chat app.
2675
+ # // Supports the following types of
2676
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
2614
2677
  #
2615
- # Requires [user
2678
+ # - [App
2679
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
2680
+ #
2681
+ # - [User
2616
2682
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
2617
- # or [app
2618
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
2619
2683
  #
2620
2684
  # @overload find_direct_message(request, options = nil)
2621
2685
  # Pass arguments to `find_direct_message` via a request object, either of type
@@ -2698,7 +2762,6 @@ module Google
2698
2762
 
2699
2763
  @chat_service_stub.call_rpc :find_direct_message, request, options: options do |response, operation|
2700
2764
  yield response, operation if block_given?
2701
- return response
2702
2765
  end
2703
2766
  rescue ::GRPC::BadStatus => e
2704
2767
  raise ::Google::Cloud::Error.from_error(e)
@@ -2711,8 +2774,19 @@ module Google
2711
2774
  # policy turned off, then they're invited, and must accept the space
2712
2775
  # invitation before joining. Otherwise, creating a membership adds the member
2713
2776
  # directly to the specified space.
2714
- # Requires [user
2715
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
2777
+ #
2778
+ # Supports the following types of
2779
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
2780
+ #
2781
+ # - [App
2782
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
2783
+ # with [administrator approval](https://support.google.com/a?p=chat-app-auth)
2784
+ # in [Developer Preview](https://developers.google.com/workspace/preview)
2785
+ #
2786
+ # - [User
2787
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
2788
+ # You can authenticate and authorize this method with administrator
2789
+ # privileges by setting the `use_admin_access` field in the request.
2716
2790
  #
2717
2791
  # For example usage, see:
2718
2792
  #
@@ -2747,23 +2821,44 @@ module Google
2747
2821
  # Format: spaces/\\{space}
2748
2822
  # @param membership [::Google::Apps::Chat::V1::Membership, ::Hash]
2749
2823
  # Required. The membership relation to create.
2824
+ #
2750
2825
  # The `memberType` field must contain a user with the `user.name` and
2751
2826
  # `user.type` fields populated. The server will assign a resource name
2752
2827
  # and overwrite anything specified.
2828
+ #
2753
2829
  # When a Chat app creates a membership relation for a human user, it must use
2754
- # the `chat.memberships` scope, set `user.type` to `HUMAN`, and set
2755
- # `user.name` with format `users/{user}`, where `{user}` can be the email
2756
- # address for the user. For users in the same Workspace organization `{user}`
2757
- # can also be the `id` of the
2758
- # [person](https://developers.google.com/people/api/rest/v1/people) from the
2759
- # People API, or the `id` for the user in the Directory API. For example, if
2760
- # the People API Person profile ID for `user@example.com` is `123456789`, you
2761
- # can add the user to the space by setting the `membership.member.name` to
2762
- # `users/user@example.com` or `users/123456789`. When a Chat app creates a
2763
- # membership relation for itself, it must use the `chat.memberships.app`
2764
- # scope, set `user.type` to `BOT`, and set `user.name` to `users/app`.
2830
+ # certain authorization scopes and set specific values for certain fields:
2831
+ #
2832
+ # - When [authenticating as a
2833
+ # user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
2834
+ # the `chat.memberships` authorization scope is required.
2835
+ #
2836
+ # - When [authenticating as an
2837
+ # app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
2838
+ # the `chat.app.memberships` authorization scope is required.
2839
+ # Authenticating as an app is available in [Developer
2840
+ # Preview](https://developers.google.com/workspace/preview).
2841
+ #
2842
+ # - Set `user.type` to `HUMAN`, and set `user.name` with format
2843
+ # `users/{user}`, where `{user}` can be the email address for the user. For
2844
+ # users in the same Workspace organization `{user}` can also be the `id` of
2845
+ # the [person](https://developers.google.com/people/api/rest/v1/people) from
2846
+ # the People API, or the `id` for the user in the Directory API. For example,
2847
+ # if the People API Person profile ID for `user@example.com` is `123456789`,
2848
+ # you can add the user to the space by setting the `membership.member.name`
2849
+ # to `users/user@example.com` or `users/123456789`.
2850
+ #
2851
+ # Inviting users external to the Workspace organization that owns the space
2852
+ # requires [user
2853
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
2854
+ #
2855
+ # When a Chat app creates a membership relation for itself, it must
2856
+ # [authenticate as a
2857
+ # user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
2858
+ # and use the `chat.memberships.app` scope, set `user.type` to `BOT`, and set
2859
+ # `user.name` to `users/app`.
2765
2860
  # @param use_admin_access [::Boolean]
2766
- # When `true`, the method runs using the user's Google Workspace
2861
+ # Optional. When `true`, the method runs using the user's Google Workspace
2767
2862
  # administrator privileges.
2768
2863
  #
2769
2864
  # The calling user must be a Google Workspace administrator with the
@@ -2836,7 +2931,6 @@ module Google
2836
2931
 
2837
2932
  @chat_service_stub.call_rpc :create_membership, request, options: options do |response, operation|
2838
2933
  yield response, operation if block_given?
2839
- return response
2840
2934
  end
2841
2935
  rescue ::GRPC::BadStatus => e
2842
2936
  raise ::Google::Cloud::Error.from_error(e)
@@ -2846,8 +2940,18 @@ module Google
2846
2940
  # Updates a membership. For an example, see [Update a user's membership in
2847
2941
  # a space](https://developers.google.com/workspace/chat/update-members).
2848
2942
  #
2849
- # Requires [user
2850
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
2943
+ # Supports the following types of
2944
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
2945
+ #
2946
+ # - [App
2947
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
2948
+ # with [administrator approval](https://support.google.com/a?p=chat-app-auth)
2949
+ # in [Developer Preview](https://developers.google.com/workspace/preview)
2950
+ #
2951
+ # - [User
2952
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
2953
+ # You can authenticate and authorize this method with administrator
2954
+ # privileges by setting the `use_admin_access` field in the request.
2851
2955
  #
2852
2956
  # @overload update_membership(request, options = nil)
2853
2957
  # Pass arguments to `update_membership` via a request object, either of type
@@ -2875,7 +2979,7 @@ module Google
2875
2979
  #
2876
2980
  # - `role`
2877
2981
  # @param use_admin_access [::Boolean]
2878
- # When `true`, the method runs using the user's Google Workspace
2982
+ # Optional. When `true`, the method runs using the user's Google Workspace
2879
2983
  # administrator privileges.
2880
2984
  #
2881
2985
  # The calling user must be a Google Workspace administrator with the
@@ -2944,7 +3048,6 @@ module Google
2944
3048
 
2945
3049
  @chat_service_stub.call_rpc :update_membership, request, options: options do |response, operation|
2946
3050
  yield response, operation if block_given?
2947
- return response
2948
3051
  end
2949
3052
  rescue ::GRPC::BadStatus => e
2950
3053
  raise ::Google::Cloud::Error.from_error(e)
@@ -2955,8 +3058,18 @@ module Google
2955
3058
  # [Remove a user or a Google Chat app from a
2956
3059
  # space](https://developers.google.com/workspace/chat/delete-members).
2957
3060
  #
2958
- # Requires [user
2959
- # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
3061
+ # Supports the following types of
3062
+ # [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
3063
+ #
3064
+ # - [App
3065
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
3066
+ # with [administrator approval](https://support.google.com/a?p=chat-app-auth)
3067
+ # in [Developer Preview](https://developers.google.com/workspace/preview)
3068
+ #
3069
+ # - [User
3070
+ # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
3071
+ # You can authenticate and authorize this method with administrator
3072
+ # privileges by setting the `use_admin_access` field in the request.
2960
3073
  #
2961
3074
  # @overload delete_membership(request, options = nil)
2962
3075
  # Pass arguments to `delete_membership` via a request object, either of type
@@ -2989,7 +3102,7 @@ module Google
2989
3102
  #
2990
3103
  # Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.
2991
3104
  # @param use_admin_access [::Boolean]
2992
- # When `true`, the method runs using the user's Google Workspace
3105
+ # Optional. When `true`, the method runs using the user's Google Workspace
2993
3106
  # administrator privileges.
2994
3107
  #
2995
3108
  # The calling user must be a Google Workspace administrator with the
@@ -3060,7 +3173,6 @@ module Google
3060
3173
 
3061
3174
  @chat_service_stub.call_rpc :delete_membership, request, options: options do |response, operation|
3062
3175
  yield response, operation if block_given?
3063
- return response
3064
3176
  end
3065
3177
  rescue ::GRPC::BadStatus => e
3066
3178
  raise ::Google::Cloud::Error.from_error(e)
@@ -3071,6 +3183,7 @@ module Google
3071
3183
  # supported. For an example, see
3072
3184
  # [Add a reaction to a
3073
3185
  # message](https://developers.google.com/workspace/chat/create-reactions).
3186
+ #
3074
3187
  # Requires [user
3075
3188
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
3076
3189
  #
@@ -3155,7 +3268,6 @@ module Google
3155
3268
 
3156
3269
  @chat_service_stub.call_rpc :create_reaction, request, options: options do |response, operation|
3157
3270
  yield response, operation if block_given?
3158
- return response
3159
3271
  end
3160
3272
  rescue ::GRPC::BadStatus => e
3161
3273
  raise ::Google::Cloud::Error.from_error(e)
@@ -3165,6 +3277,7 @@ module Google
3165
3277
  # Lists reactions to a message. For an example, see
3166
3278
  # [List reactions for a
3167
3279
  # message](https://developers.google.com/workspace/chat/list-reactions).
3280
+ #
3168
3281
  # Requires [user
3169
3282
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
3170
3283
  #
@@ -3309,7 +3422,7 @@ module Google
3309
3422
  @chat_service_stub.call_rpc :list_reactions, request, options: options do |response, operation|
3310
3423
  response = ::Gapic::PagedEnumerable.new @chat_service_stub, :list_reactions, request, response, operation, options
3311
3424
  yield response, operation if block_given?
3312
- return response
3425
+ throw :response, response
3313
3426
  end
3314
3427
  rescue ::GRPC::BadStatus => e
3315
3428
  raise ::Google::Cloud::Error.from_error(e)
@@ -3320,6 +3433,7 @@ module Google
3320
3433
  # For an example, see
3321
3434
  # [Delete a
3322
3435
  # reaction](https://developers.google.com/workspace/chat/delete-reactions).
3436
+ #
3323
3437
  # Requires [user
3324
3438
  # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
3325
3439
  #
@@ -3402,7 +3516,6 @@ module Google
3402
3516
 
3403
3517
  @chat_service_stub.call_rpc :delete_reaction, request, options: options do |response, operation|
3404
3518
  yield response, operation if block_given?
3405
- return response
3406
3519
  end
3407
3520
  rescue ::GRPC::BadStatus => e
3408
3521
  raise ::Google::Cloud::Error.from_error(e)
@@ -3508,7 +3621,6 @@ module Google
3508
3621
 
3509
3622
  @chat_service_stub.call_rpc :get_space_read_state, request, options: options do |response, operation|
3510
3623
  yield response, operation if block_given?
3511
- return response
3512
3624
  end
3513
3625
  rescue ::GRPC::BadStatus => e
3514
3626
  raise ::Google::Cloud::Error.from_error(e)
@@ -3627,7 +3739,6 @@ module Google
3627
3739
 
3628
3740
  @chat_service_stub.call_rpc :update_space_read_state, request, options: options do |response, operation|
3629
3741
  yield response, operation if block_given?
3630
- return response
3631
3742
  end
3632
3743
  rescue ::GRPC::BadStatus => e
3633
3744
  raise ::Google::Cloud::Error.from_error(e)
@@ -3734,7 +3845,6 @@ module Google
3734
3845
 
3735
3846
  @chat_service_stub.call_rpc :get_thread_read_state, request, options: options do |response, operation|
3736
3847
  yield response, operation if block_given?
3737
- return response
3738
3848
  end
3739
3849
  rescue ::GRPC::BadStatus => e
3740
3850
  raise ::Google::Cloud::Error.from_error(e)
@@ -3838,7 +3948,6 @@ module Google
3838
3948
 
3839
3949
  @chat_service_stub.call_rpc :get_space_event, request, options: options do |response, operation|
3840
3950
  yield response, operation if block_given?
3841
- return response
3842
3951
  end
3843
3952
  rescue ::GRPC::BadStatus => e
3844
3953
  raise ::Google::Cloud::Error.from_error(e)
@@ -3887,8 +3996,8 @@ module Google
3887
3996
  #
3888
3997
  # Negative values return an `INVALID_ARGUMENT` error.
3889
3998
  # @param page_token [::String]
3890
- # A page token, received from a previous list space events call. Provide this
3891
- # to retrieve the subsequent page.
3999
+ # Optional. A page token, received from a previous list space events call.
4000
+ # Provide this to retrieve the subsequent page.
3892
4001
  #
3893
4002
  # When paginating, all other parameters provided to list space events must
3894
4003
  # match the call that provided the page token. Passing different values to
@@ -4011,7 +4120,7 @@ module Google
4011
4120
  @chat_service_stub.call_rpc :list_space_events, request, options: options do |response, operation|
4012
4121
  response = ::Gapic::PagedEnumerable.new @chat_service_stub, :list_space_events, request, response, operation, options
4013
4122
  yield response, operation if block_given?
4014
- return response
4123
+ throw :response, response
4015
4124
  end
4016
4125
  rescue ::GRPC::BadStatus => e
4017
4126
  raise ::Google::Cloud::Error.from_error(e)
@@ -4100,6 +4209,11 @@ module Google
4100
4209
  # default endpoint URL. The default value of nil uses the environment
4101
4210
  # universe (usually the default "googleapis.com" universe).
4102
4211
  # @return [::String,nil]
4212
+ # @!attribute [rw] logger
4213
+ # A custom logger to use for request/response debug logging, or the value
4214
+ # `:default` (the default) to construct a default logger, or `nil` to
4215
+ # explicitly disable logging.
4216
+ # @return [::Logger,:default,nil]
4103
4217
  #
4104
4218
  class Configuration
4105
4219
  extend ::Gapic::Config
@@ -4124,6 +4238,7 @@ module Google
4124
4238
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
4125
4239
  config_attr :quota_project, nil, ::String, nil
4126
4240
  config_attr :universe_domain, nil, ::String, nil
4241
+ config_attr :logger, :default, ::Logger, nil, :default
4127
4242
 
4128
4243
  # @private
4129
4244
  def initialize parent_config = nil