Skip to content

Commit 66162a7

Browse files
gcf-owl-bot[bot]parthea
gcf-owl-bot[bot]
and
parthea
authored
docs: [google-apps-chat]Chat API documentation update (googleapis#12574)
BEGIN_COMMIT_OVERRIDE docs: Chat API documentation update fix(deps): Require google-apps-card >= 0.1.2 END_COMMIT_OVERRIDE - [ ] Regenerate this pull request now. PiperOrigin-RevId: 625051297 Source-Link: googleapis/googleapis@81c27a6 Source-Link: https://github.com/googleapis/googleapis-gen/commit/5bf8ea2c710d1386bc6dc452f8b6a4e72bb3fe24 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwcHMtY2hhdC8uT3dsQm90LnlhbWwiLCJoIjoiNWJmOGVhMmM3MTBkMTM4NmJjNmRjNDUyZjhiNmE0ZTcyYmIzZmUyNCJ9 --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
1 parent 6239d5b commit 66162a7

File tree

23 files changed

+551
-514
lines changed

23 files changed

+551
-514
lines changed

‎packages/google-apps-chat/google/apps/chat/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.1.2" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-apps-chat/google/apps/chat_v1/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.1.2" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-apps-chat/google/apps/chat_v1/services/chat_service/async_client.py‎

Lines changed: 115 additions & 92 deletions
Large diffs are not rendered by default.

‎packages/google-apps-chat/google/apps/chat_v1/services/chat_service/client.py‎

Lines changed: 115 additions & 92 deletions
Large diffs are not rendered by default.

‎packages/google-apps-chat/google/apps/chat_v1/services/chat_service/transports/grpc.py‎

Lines changed: 84 additions & 76 deletions
Large diffs are not rendered by default.

‎packages/google-apps-chat/google/apps/chat_v1/services/chat_service/transports/grpc_asyncio.py‎

Lines changed: 84 additions & 76 deletions
Large diffs are not rendered by default.

‎packages/google-apps-chat/google/apps/chat_v1/services/chat_service/transports/rest.py‎

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -819,6 +819,8 @@ def __call__(
819819
820820
Returns:
821821
~.space.CompleteImportSpaceResponse:
822+
Response message for completing the
823+
import process for a space.
822824
823825
"""
824826

@@ -904,7 +906,8 @@ def __call__(
904906
905907
Args:
906908
request (~.gc_membership.CreateMembershipRequest):
907-
The request object.
909+
The request object. Request message for creating a
910+
membership.
908911
retry (google.api_core.retry.Retry): Designation of what errors, if any,
909912
should be retried.
910913
timeout (float): The timeout for this request.
@@ -1186,7 +1189,7 @@ def __call__(
11861189
11871190
Args:
11881191
request (~.gc_space.CreateSpaceRequest):
1189-
The request object.
1192+
The request object. A request to create a named space.
11901193
retry (google.api_core.retry.Retry): Designation of what errors, if any,
11911194
should be retried.
11921195
timeout (float): The timeout for this request.
@@ -1282,7 +1285,8 @@ def __call__(
12821285
12831286
Args:
12841287
request (~.membership.DeleteMembershipRequest):
1285-
The request object.
1288+
The request object. Request to delete a membership in a
1289+
space.
12861290
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12871291
should be retried.
12881292
timeout (float): The timeout for this request.
@@ -1373,7 +1377,7 @@ def __call__(
13731377
13741378
Args:
13751379
request (~.message.DeleteMessageRequest):
1376-
The request object.
1380+
The request object. Request to delete a message.
13771381
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13781382
should be retried.
13791383
timeout (float): The timeout for this request.
@@ -1686,7 +1690,7 @@ def __call__(
16861690
16871691
Args:
16881692
request (~.attachment.GetAttachmentRequest):
1689-
The request object.
1693+
The request object. Request to get an attachment.
16901694
retry (google.api_core.retry.Retry): Designation of what errors, if any,
16911695
should be retried.
16921696
timeout (float): The timeout for this request.
@@ -1771,7 +1775,8 @@ def __call__(
17711775
17721776
Args:
17731777
request (~.membership.GetMembershipRequest):
1774-
The request object.
1778+
The request object. Request to get a membership of a
1779+
space.
17751780
retry (google.api_core.retry.Retry): Designation of what errors, if any,
17761781
should be retried.
17771782
timeout (float): The timeout for this request.
@@ -1860,7 +1865,7 @@ def __call__(
18601865
18611866
Args:
18621867
request (~.message.GetMessageRequest):
1863-
The request object.
1868+
The request object. Request to get a message.
18641869
retry (google.api_core.retry.Retry): Designation of what errors, if any,
18651870
should be retried.
18661871
timeout (float): The timeout for this request.
@@ -2034,7 +2039,8 @@ def __call__(
20342039
20352040
Args:
20362041
request (~.membership.ListMembershipsRequest):
2037-
The request object.
2042+
The request object. Request message for listing
2043+
memberships.
20382044
retry (google.api_core.retry.Retry): Designation of what errors, if any,
20392045
should be retried.
20402046
timeout (float): The timeout for this request.
@@ -2043,6 +2049,8 @@ def __call__(
20432049
20442050
Returns:
20452051
~.membership.ListMembershipsResponse:
2052+
Response to list memberships of the
2053+
space.
20462054
20472055
"""
20482056

@@ -2131,6 +2139,8 @@ def __call__(
21312139
21322140
Returns:
21332141
~.message.ListMessagesResponse:
2142+
Response message for listing
2143+
messages.
21342144
21352145
"""
21362146

@@ -2216,7 +2226,7 @@ def __call__(
22162226
22172227
Returns:
22182228
~.reaction.ListReactionsResponse:
2219-
2229+
Response to a list reactions request.
22202230
"""
22212231

22222232
http_options: List[Dict[str, str]] = [
@@ -2292,6 +2302,8 @@ def __call__(
22922302
22932303
Returns:
22942304
~.space.ListSpacesResponse:
2305+
The response for a list spaces
2306+
request.
22952307
22962308
"""
22972309

@@ -2367,7 +2379,8 @@ def __call__(
23672379
23682380
Args:
23692381
request (~.space_setup.SetUpSpaceRequest):
2370-
The request object.
2382+
The request object. Request to create a space and add
2383+
specified users to it.
23712384
retry (google.api_core.retry.Retry): Designation of what errors, if any,
23722385
should be retried.
23732386
timeout (float): The timeout for this request.
@@ -2463,7 +2476,7 @@ def __call__(
24632476
24642477
Args:
24652478
request (~.gc_message.UpdateMessageRequest):
2466-
The request object.
2479+
The request object. Request to update a message.
24672480
retry (google.api_core.retry.Retry): Designation of what errors, if any,
24682481
should be retried.
24692482
timeout (float): The timeout for this request.
@@ -2656,7 +2669,7 @@ def __call__(
26562669
26572670
Args:
26582671
request (~.attachment.UploadAttachmentRequest):
2659-
The request object.
2672+
The request object. Request to upload an attachment.
26602673
retry (google.api_core.retry.Retry): Designation of what errors, if any,
26612674
should be retried.
26622675
timeout (float): The timeout for this request.
@@ -2665,7 +2678,7 @@ def __call__(
26652678
26662679
Returns:
26672680
~.attachment.UploadAttachmentResponse:
2668-
2681+
Response of uploading an attachment.
26692682
"""
26702683

26712684
http_options: List[Dict[str, str]] = [

‎packages/google-apps-chat/google/apps/chat_v1/types/action_status.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
class ActionStatus(proto.Message):
3232
r"""Represents the status for a request to either invoke or submit a
33-
`dialog <https://developers.google.com/chat/how-tos/dialogs>`__.
33+
`dialog <https://developers.google.com/workspace/chat/dialogs>`__.
3434
3535
Attributes:
3636
status_code (google.rpc.code_pb2.Code):

‎packages/google-apps-chat/google/apps/chat_v1/types/annotation.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ class AnnotationType(proto.Enum):
5757
class Annotation(proto.Message):
5858
r"""Output only. Annotations associated with the plain-text body of the
5959
message. To add basic formatting to a text message, see `Format text
60-
messages <https://developers.google.com/chat/format-messages>`__.
60+
messages <https://developers.google.com/workspace/chat/format-messages>`__.
6161
6262
Example plain-text message body:
6363
@@ -295,7 +295,7 @@ class DriveLinkData(proto.Message):
295295
Attributes:
296296
drive_data_ref (google.apps.chat_v1.types.DriveDataRef):
297297
A
298-
`DriveDataRef <https://developers.google.com/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref>`__
298+
`DriveDataRef <https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref>`__
299299
which references a Google Drive file.
300300
mime_type (str):
301301
The mime type of the linked Google Drive

‎packages/google-apps-chat/google/apps/chat_v1/types/attachment.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,15 @@ class Attachment(proto.Message):
7979
"""
8080

8181
class Source(proto.Enum):
82-
r"""
82+
r"""The source of the attachment.
8383
8484
Values:
8585
SOURCE_UNSPECIFIED (0):
86-
No description available.
86+
Reserved.
8787
DRIVE_FILE (1):
88-
No description available.
88+
The file is a Google Drive file.
8989
UPLOADED_CONTENT (2):
90-
No description available.
90+
The file is uploaded to Chat.
9191
"""
9292
SOURCE_UNSPECIFIED = 0
9393
DRIVE_FILE = 1
@@ -148,7 +148,7 @@ class DriveDataRef(proto.Message):
148148

149149

150150
class AttachmentDataRef(proto.Message):
151-
r"""
151+
r"""A reference to the attachment data.
152152
153153
Attributes:
154154
resource_name (str):
@@ -173,7 +173,7 @@ class AttachmentDataRef(proto.Message):
173173

174174

175175
class GetAttachmentRequest(proto.Message):
176-
r"""
176+
r"""Request to get an attachment.
177177
178178
Attributes:
179179
name (str):
@@ -188,7 +188,7 @@ class GetAttachmentRequest(proto.Message):
188188

189189

190190
class UploadAttachmentRequest(proto.Message):
191-
r"""
191+
r"""Request to upload an attachment.
192192
193193
Attributes:
194194
parent (str):
@@ -211,7 +211,7 @@ class UploadAttachmentRequest(proto.Message):
211211

212212

213213
class UploadAttachmentResponse(proto.Message):
214-
r"""
214+
r"""Response of uploading an attachment.
215215
216216
Attributes:
217217
attachment_data_ref (google.apps.chat_v1.types.AttachmentDataRef):

0 commit comments

Comments
 (0)