Skip to content

docs: [google-apps-chat]Chat API documentation update #12574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
parthea merged 5 commits into from
Apr 16, 2024
Merged

docs: [google-apps-chat]Chat API documentation update #12574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8312013
docs:Chat API documentation update
gcf-owl-bot[bot] Apr 15, 2024
0362deb
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Apr 15, 2024
1a2794e
require google-apps-card>=0.1.2
parthea Apr 16, 2024
c294765
Merge branch 'main' into owl-bot-copy-packages-google-apps-chat
parthea Apr 16, 2024
43dcac3
See https://github.com/googleapis/gapic-generator-python/issues/1969
parthea Mar 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/google-apps-chat/google/apps/chat/gapic_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "0.1.2" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
2 changes: 1 addition & 1 deletion packages/google-apps-chat/google/apps/chat_v1/gapic_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "0.1.2" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
207 changes: 115 additions & 92 deletions packages/google-apps-chat/google/apps/chat_v1/services/chat_service/async_client.py
View file
Open in desktop

Large diffs are not rendered by default.

207 changes: 115 additions & 92 deletions packages/google-apps-chat/google/apps/chat_v1/services/chat_service/client.py
View file
Open in desktop

Large diffs are not rendered by default.

160 changes: 84 additions & 76 deletions packages/google-apps-chat/google/apps/chat_v1/services/chat_service/transports/grpc.py
View file
Open in desktop

Large diffs are not rendered by default.

160 changes: 84 additions & 76 deletions ...ges/google-apps-chat/google/apps/chat_v1/services/chat_service/transports/grpc_asyncio.py
View file
Open in desktop

Large diffs are not rendered by default.

39 changes: 26 additions & 13 deletions packages/google-apps-chat/google/apps/chat_v1/services/chat_service/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -819,6 +819,8 @@ def __call__(

Returns:
~.space.CompleteImportSpaceResponse:
Response message for completing the
import process for a space.

"""

Expand Down Expand Up @@ -904,7 +906,8 @@ def __call__(

Args:
request (~.gc_membership.CreateMembershipRequest):
The request object.
The request object. Request message for creating a
membership.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1186,7 +1189,7 @@ def __call__(

Args:
request (~.gc_space.CreateSpaceRequest):
The request object.
The request object. A request to create a named space.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1282,7 +1285,8 @@ def __call__(

Args:
request (~.membership.DeleteMembershipRequest):
The request object.
The request object. Request to delete a membership in a
space.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1373,7 +1377,7 @@ def __call__(

Args:
request (~.message.DeleteMessageRequest):
The request object.
The request object. Request to delete a message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1686,7 +1690,7 @@ def __call__(

Args:
request (~.attachment.GetAttachmentRequest):
The request object.
The request object. Request to get an attachment.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1771,7 +1775,8 @@ def __call__(

Args:
request (~.membership.GetMembershipRequest):
The request object.
The request object. Request to get a membership of a
space.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1860,7 +1865,7 @@ def __call__(

Args:
request (~.message.GetMessageRequest):
The request object.
The request object. Request to get a message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2034,7 +2039,8 @@ def __call__(

Args:
request (~.membership.ListMembershipsRequest):
The request object.
The request object. Request message for listing
memberships.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand All @@ -2043,6 +2049,8 @@ def __call__(

Returns:
~.membership.ListMembershipsResponse:
Response to list memberships of the
space.

"""

Expand Down Expand Up @@ -2131,6 +2139,8 @@ def __call__(

Returns:
~.message.ListMessagesResponse:
Response message for listing
messages.

"""

Expand Down Expand Up @@ -2216,7 +2226,7 @@ def __call__(

Returns:
~.reaction.ListReactionsResponse:

Response to a list reactions request.
"""

http_options: List[Dict[str, str]] = [
Expand Down Expand Up @@ -2292,6 +2302,8 @@ def __call__(

Returns:
~.space.ListSpacesResponse:
The response for a list spaces
request.

"""

Expand Down Expand Up @@ -2367,7 +2379,8 @@ def __call__(

Args:
request (~.space_setup.SetUpSpaceRequest):
The request object.
The request object. Request to create a space and add
specified users to it.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2463,7 +2476,7 @@ def __call__(

Args:
request (~.gc_message.UpdateMessageRequest):
The request object.
The request object. Request to update a message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2656,7 +2669,7 @@ def __call__(

Args:
request (~.attachment.UploadAttachmentRequest):
The request object.
The request object. Request to upload an attachment.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand All @@ -2665,7 +2678,7 @@ def __call__(

Returns:
~.attachment.UploadAttachmentResponse:

Response of uploading an attachment.
"""

http_options: List[Dict[str, str]] = [
Expand Down
2 changes: 1 addition & 1 deletion packages/google-apps-chat/google/apps/chat_v1/types/action_status.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

class ActionStatus(proto.Message):
r"""Represents the status for a request to either invoke or submit a
`dialog <https://developers.google.com/chat/how-tos/dialogs>`__.
`dialog <https://developers.google.com/workspace/chat/dialogs>`__.

Attributes:
status_code (google.rpc.code_pb2.Code):
Expand Down
4 changes: 2 additions & 2 deletions packages/google-apps-chat/google/apps/chat_v1/types/annotation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ class AnnotationType(proto.Enum):
class Annotation(proto.Message):
r"""Output only. Annotations associated with the plain-text body of the
message. To add basic formatting to a text message, see `Format text
messages <https://developers.google.com/chat/format-messages>`__.
messages <https://developers.google.com/workspace/chat/format-messages>`__.

Example plain-text message body:

Expand Down Expand Up @@ -295,7 +295,7 @@ class DriveLinkData(proto.Message):
Attributes:
drive_data_ref (google.apps.chat_v1.types.DriveDataRef):
A
`DriveDataRef <https://developers.google.com/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref>`__
`DriveDataRef <https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref>`__
which references a Google Drive file.
mime_type (str):
The mime type of the linked Google Drive
Expand Down
16 changes: 8 additions & 8 deletions packages/google-apps-chat/google/apps/chat_v1/types/attachment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,15 @@ class Attachment(proto.Message):
"""

class Source(proto.Enum):
r"""
r"""The source of the attachment.

Values:
SOURCE_UNSPECIFIED (0):
No description available.
Reserved.
DRIVE_FILE (1):
No description available.
The file is a Google Drive file.
UPLOADED_CONTENT (2):
No description available.
The file is uploaded to Chat.
"""
SOURCE_UNSPECIFIED = 0
DRIVE_FILE = 1
Expand Down Expand Up @@ -148,7 +148,7 @@ class DriveDataRef(proto.Message):


class AttachmentDataRef(proto.Message):
r"""
r"""A reference to the attachment data.

Attributes:
resource_name (str):
Expand All @@ -173,7 +173,7 @@ class AttachmentDataRef(proto.Message):


class GetAttachmentRequest(proto.Message):
r"""
r"""Request to get an attachment.

Attributes:
name (str):
Expand All @@ -188,7 +188,7 @@ class GetAttachmentRequest(proto.Message):


class UploadAttachmentRequest(proto.Message):
r"""
r"""Request to upload an attachment.

Attributes:
parent (str):
Expand All @@ -211,7 +211,7 @@ class UploadAttachmentRequest(proto.Message):


class UploadAttachmentResponse(proto.Message):
r"""
r"""Response of uploading an attachment.

Attributes:
attachment_data_ref (google.apps.chat_v1.types.AttachmentDataRef):
Expand Down
2 changes: 1 addition & 1 deletion packages/google-apps-chat/google/apps/chat_v1/types/contextual_addon.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ class Section(proto.Message):
The header of the section. Formatted text is supported. For
more information about formatting text, see `Formatting text
in Google Chat
apps <https://developers.google.com/chat/format-messages#card-formatting>`__
apps <https://developers.google.com/workspace/chat/format-messages#card-formatting>`__
and `Formatting text in Google Workspace
Add-ons <https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting>`__.
widgets (MutableSequence[google.apps.chat_v1.types.WidgetMarkup]):
Expand Down
26 changes: 13 additions & 13 deletions packages/google-apps-chat/google/apps/chat_v1/types/membership.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ class Membership(proto.Message):
member (google.apps.chat_v1.types.User):
The Google Chat user or app the membership corresponds to.
If your Chat app `authenticates as a
user <https://developers.google.com/chat/api/guides/auth/users>`__,
user <https://developers.google.com/workspace/chat/authenticate-authorize-chat-user>`__,
the output populates the
`user <https://developers.google.com/chat/api/reference/rest/v1/User>`__
`user <https://developers.google.com/workspace/chat/api/reference/rest/v1/User>`__
``name`` and ``type``.

This field is a member of `oneof`_ ``memberType``.
Expand Down Expand Up @@ -181,7 +181,7 @@ class MembershipRole(proto.Enum):


class CreateMembershipRequest(proto.Message):
r"""
r"""Request message for creating a membership.

Attributes:
parent (str):
Expand Down Expand Up @@ -224,7 +224,7 @@ class CreateMembershipRequest(proto.Message):


class ListMembershipsRequest(proto.Message):
r"""
r"""Request message for listing memberships.

Attributes:
parent (str):
Expand All @@ -238,8 +238,8 @@ class ListMembershipsRequest(proto.Message):

If unspecified, at most 100 memberships are returned.

The maximum value is 1,000. If you use a value more than
1,000, it's automatically changed to 1,000.
The maximum value is 1000. If you use a value more than
1000, it's automatically changed to 1000.

Negative values return an ``INVALID_ARGUMENT`` error.
page_token (str):
Expand All @@ -255,9 +255,9 @@ class ListMembershipsRequest(proto.Message):
Optional. A query filter.

You can filter memberships by a member's role
(```role`` <https://developers.google.com/chat/api/reference/rest/v1/spaces.members#membershiprole>`__)
(```role`` <https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole>`__)
and type
(```member.type`` <https://developers.google.com/chat/api/reference/rest/v1/User#type>`__).
(```member.type`` <https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type>`__).

To filter by role, set ``role`` to ``ROLE_MEMBER`` or
``ROLE_MANAGER``.
Expand Down Expand Up @@ -304,7 +304,7 @@ class ListMembershipsRequest(proto.Message):
returned.

Currently requires `user
authentication <https://developers.google.com/chat/api/guides/auth/users>`__.
authentication <https://developers.google.com/workspace/chat/authenticate-authorize-chat-user>`__.
"""

parent: str = proto.Field(
Expand Down Expand Up @@ -334,7 +334,7 @@ class ListMembershipsRequest(proto.Message):


class ListMembershipsResponse(proto.Message):
r"""
r"""Response to list memberships of the space.

Attributes:
memberships (MutableSequence[google.apps.chat_v1.types.Membership]):
Expand Down Expand Up @@ -362,7 +362,7 @@ def raw_page(self):


class GetMembershipRequest(proto.Message):
r"""
r"""Request to get a membership of a space.

Attributes:
name (str):
Expand All @@ -375,7 +375,7 @@ class GetMembershipRequest(proto.Message):
``spaces/{space}/members/app``

When `authenticated as a
user <https://developers.google.com/chat/api/guides/auth/users>`__,
user <https://developers.google.com/workspace/chat/authenticate-authorize-chat-user>`__,
you can use the user's email as an alias for ``{member}``.
For example, ``spaces/{space}/members/example@gmail.com``
where ``example@gmail.com`` is the email of the Google Chat
Expand All @@ -389,7 +389,7 @@ class GetMembershipRequest(proto.Message):


class DeleteMembershipRequest(proto.Message):
r"""
r"""Request to delete a membership in a space.

Attributes:
name (str):
Expand Down
Loading