Feature/communication chat preview3 new model (#16561)

* Rsarkar/chat preview3 rebased (#16463) * ACS Chat: Changes for API version: 2020-11-01-preview3 (#15455) Several changes required by `2020-11-01-preview3` of the API: - Rename `Thread Members` to `Participants` - Rename function `UpdateThread` to `UpdateTopic` - Rename `ReadReceipt` to `ChatMessageReadReceipt` in model - Return message id (string) instead of SendMessageResult (object) when calling `send_message` - Add a convenience method `add_participant` for adding 1 participant - Add failed participants check in response header in `create_thread` function Misc: - Add updated test record files Co-authored-by: Leo Li <[email protected]> Co-authored-by: Rajarshi Sarkar <[email protected]> * Update ACS Chat Python SDK align with swagger changes (#15640) - Seperate AzureCommunicationChatServiceOperationsMixin into ChatOperations and ChatThreadOperations - Move invalid participants into errors object in reponse body Co-authored-by: Leo Li <[email protected]> * Communication chat - paginated results for participants and readreceipts (#15682) * Failed participant check + single member add * Add failed participant check in response header for create_thread method * New convention method add_participant(thread_participant: ChatThreadParticipant) - sync and async * Add empty line at the end of files * Enable pagination for list participants * Enable pagination for read receipts * conflicts resolved after merge with upstream * update README.md * e2e test fix * bkp commit * updated e2e tests * adding test recording Co-authored-by: Leo Li <[email protected]> * Updated swagger changes (#16390) * Updated swagger changes - Generate new models from swagger - ChatMessage.content -> ChatMessageContent instead of 'str' - Remove ChatMessagePriority - Introduce ChatMessageType - Add tests around ChatMessageType deserialization - Generate a repeatability ID by default - Add some test scenarios around repeatability ID - Update all relevant tests - Update sample code - Record new test sessions * Rebase with master - Use CommunicationUserIdentifier * pylint fixes Co-authored-by: Jixing (Leo) Li <[email protected]> Co-authored-by: Leo Li <[email protected]> * Apiview changes (#16560) * apiview fixes - Add missing type hints - return ItemPaged or AsyncItemPaged instead of full classpath Co-authored-by: Jixing (Leo) Li <[email protected]> Co-authored-by: Leo Li <[email protected]>
Azure · Feb 5, 2021 · 70d098b · 70d098b
1 parent 3be037d
commit 70d098b
Show file tree

Hide file tree

Showing 74 changed files with 10,182 additions and 5,226 deletions.
diff --git a/sdk/communication/azure-communication-chat/README.md b/sdk/communication/azure-communication-chat/README.md
@@ -36,8 +36,8 @@ tokenresponse = identity_client.issue_token(user, scopes=["chat"])
 token = tokenresponse.token
 ```
 
-The `user` created above will be used later, because that user should be added as a member of new chat thread when you creating
-it with this token. It is because the initiator of the create request must be in the list of the members of the chat thread.
+The `user` created above will be used later, because that user should be added as a participant of new chat thread when you creating
+it with this token. It is because the initiator of the create request must be in the list of the participants of the chat thread.
 
 ## Create the Chat Client
 
@@ -55,12 +55,21 @@ chat_client = ChatClient(endpoint, CommunicationTokenCredential(refresh_options)
 ## Create Chat Thread Client
 
 The ChatThreadClient will allow you to perform operations specific to a chat thread, like send message, get message, update
-the chat thread topic, add members to chat thread, etc.
+the chat thread topic, add participants to chat thread, etc.
 
 You can get it by creating a new chat thread using ChatClient:
 
 ```python
-chat_thread_client = chat_client.create_chat_thread(topic, thread_members)
+chat_thread_client = chat_client.create_chat_thread(topic, thread_participants)
+```
+
+Additionally, the client can also direct so that the request is repeatable; that is, if the client makes the 
+request multiple times with the same Repeatability-Request-ID and it will get back an appropriate response without 
+the server executing the request multiple times. The value of the Repeatability-Request-ID is an opaque string 
+representing a client-generated, globally unique for all time, identifier for the request.
+
+```python
+chat_thread_client = chat_client.create_chat_thread(topic, thread_participants, repeatability_request_id)
 ```
 
 Alternatively, if you have created a chat thread before and you have its thread_id, you can create it by:
@@ -71,14 +80,14 @@ chat_thread_client = chat_client.get_chat_thread_client(thread_id)
 
 # Key concepts
 
-A chat conversation is represented by a chat thread. Each user in the thread is called a thread member. Thread members can chat with one another privately in a 1:1 chat or huddle up in a 1:N group chat. Users also get near real-time updates for when others are typing and when they have read the messages.
+A chat conversation is represented by a chat thread. Each user in the thread is called a thread participant. Thread participants can chat with one another privately in a 1:1 chat or huddle up in a 1:N group chat. Users also get near real-time updates for when others are typing and when they have read the messages.
 
 Once you initialized a `ChatClient` class, you can do the following chat operations:
 
 ## Create, get, update, and delete threads
 
 ```Python
-create_chat_thread(topic, thread_members, **kwargs)
+create_chat_thread(topic, thread_participants, **kwargs)
 get_chat_thread(thread_id, **kwargs)
 list_chat_threads(**kwargs)
 delete_chat_thread(thread_id, **kwargs)
@@ -89,7 +98,7 @@ Once you initialized a `ChatThreadClient` class, you can do the following chat o
 ## Update thread
 
 ```python
-update_thread(topic, **kwargs)
+update_topic(topic, **kwargs)
 ```
 
 ## Send, get, update, and delete messages
@@ -102,12 +111,12 @@ update_message(message_id, content, **kwargs)
 delete_message(message_id, **kwargs)
 ```
 
-## Get, add, and remove members
+## Get, add, and remove participants
 
 ```Python
-list_members(**kwargs)
-add_members(thread_members, **kwargs)
-remove_member(member_id, **kwargs)
+list_participants(**kwargs)
+add_participants(thread_participants, **kwargs)
+remove_participant(participant_id, **kwargs)
 ```
 
 ## Send typing notification
@@ -131,7 +140,7 @@ The following sections provide several code snippets covering some of the most c
 
 <!-- - [Thread Operations](#thread-operations)
 - [Message Operations](#message-operations)
-- [Thread Member Operations](#thread-member-operations)
+- [Thread Participant Operations](#thread-participant-operations)
 - [Events Operations](#events-operations) -->
 
 ## Thread Operations
@@ -141,27 +150,55 @@ The following sections provide several code snippets covering some of the most c
 Use the `create_chat_thread` method to create a chat thread client object.
 
 - Use `topic` to give a thread topic;
-- Use `thread_members` to list the `ChatThreadMember` to be added to the thread;
+- Use `thread_participants` to list the `ChatThreadParticipant` to be added to the thread;
+- Use `repeatability_request_id` to specify the unique identifier for the request.
 - `user`, required, it is the `CommunicationUserIdentifier` you created by CommunicationIdentityClient.create_user() from User Access Tokens
 <!-- [User Access Tokens](#user-access-tokens) -->
-- `display_name`, optional, is the display name for the thread member.
-- `share_history_time`, optional, time from which the chat history is shared with the member.
+- `display_name`, optional, is the display name for the thread participant.
+- `share_history_time`, optional, time from which the chat history is shared with the participant.
 
 `ChatThreadClient` is the result returned from creating a thread, you can use it to perform other chat operations to this chat thread
 
 ```Python
-from azure.communication.chat import ChatThreadMember
+# Without repeatability_request_id
+
+from azure.communication.chat import ChatThreadParticipant
 topic = "test topic"
-thread_members = [ChatThreadMember(
+thread_participants = [ChatThreadParticipant(
     user='<user>',
     display_name='name',
     share_history_time=datetime.utcnow()
 )]
 
-chat_thread_client = chat_client.create_chat_thread(topic, thread_members)
+chat_thread_client = chat_client.create_chat_thread(topic, thread_participants)
 thread_id = chat_thread_client.thread_id
 ```
 
+```Python
+# With repeatability_request_id
+
+from azure.communication.chat import ChatThreadParticipant
+import uuid
+
+# modify function to implement customer logic
+def get_unique_identifier_for_request(**kwargs):
+    res = None
+    # implement custom logic here
+    res = uuid.uuid4()
+    return res
+
+topic = "test topic"
+thread_participants = [ChatThreadParticipant(
+    user='<user>',
+    display_name='name',
+    share_history_time=datetime.utcnow()
+)]
+
+chat_thread_client = chat_client.create_chat_thread(topic, thread_participants, repeatability_request_id)
+thread_id = chat_thread_client.thread_id
+```
+
+
 ### Get a thread
 
 The `get_chat_thread` method retrieves a thread from the service.
@@ -216,7 +253,7 @@ chat_client.delete_chat_thread(thread_id)
 Use `send_message` method to sends a message to a thread identified by threadId.
 
 - Use `content` to provide the chat message content, it is required
-- Use `priority` to specify the message priority level, such as 'Normal' or 'High', if not speficied, 'Normal' will be set
+- Use `chat_message_type` to provide the chat message type. Possible values include: `ChatMessageType.TEXT`, `ChatMessageType.HTML`, `ChatMessageType.TOPIC_UPDATED`, `ChatMessageType.PARTICIPANT_ADDED`, `ChatMessageType.PARTICIPANT_REMOVED`
 - Use `sender_display_name` to specify the display name of the sender, if not specified, empty name will be set
 
 `SendChatMessageResult` is the response returned from sending a message, it contains an id, which is the unique ID of the message.
@@ -225,10 +262,9 @@ Use `send_message` method to sends a message to a thread identified by threadId.
 from azure.communication.chat import ChatMessagePriority
 
 content='hello world'
-priority=ChatMessagePriority.NORMAL
 sender_display_name='sender name'
 
-send_message_result = chat_thread_client.send_message(content, priority=priority, sender_display_name=sender_display_name)
+send_message_result = chat_thread_client.send_message(content, sender_display_name=sender_display_name)
 ```
 
 ### Get a message
@@ -282,50 +318,50 @@ Use `delete_message` to delete a message.
 chat_thread_client.delete_message(message_id)
 ```
 
-## Thread Member Operations
+## Thread Participant Operations
 
-### Get thread members
+### Get thread participants
 
-Use `list_members` to retrieve the members of the thread.
+Use `list_participants` to retrieve the participants of the thread.
 
-An iterator of `[ChatThreadMember]` is the response returned from listing members
+An iterator of `[ChatThreadParticipant]` is the response returned from listing participants
 
 ```python
-chat_thread_members = chat_thread_client.list_members()
-for chat_thread_member in chat_thread_members:
-    print(chat_thread_member)
+chat_thread_participants = chat_thread_client.list_participants(results_per_page=5, skip=5)
+for chat_thread_participant in chat_thread_participants:
+    print(chat_thread_participant)
 ```
 
-### Add thread members
+### Add thread participants
 
-Use `add_members` method to add thread members to the thread.
+Use `add_participants` method to add thread participants to the thread.
 
-- Use `thread_members` to list the `ChatThreadMember` to be added to the thread;
+- Use `thread_participants` to list the `ChatThreadParticipant` to be added to the thread;
 - `user`, required, it is the `CommunicationUserIdentifier` you created by CommunicationIdentityClient.create_user() from User Access Tokens
 <!-- [User Access Tokens](#user-access-tokens) -->
-- `display_name`, optional, is the display name for the thread member.
-- `share_history_time`, optional, time from which the chat history is shared with the member.
+- `display_name`, optional, is the display name for the thread participant.
+- `share_history_time`, optional, time from which the chat history is shared with the participant.
 
 ```Python
-from azure.communication.chat import ChatThreadMember
+from azure.communication.chat import ChatThreadParticipant
 from datetime import datetime
-member = ChatThreadMember(
+participant = ChatThreadParticipant(
     user='<user>',
     display_name='name',
     share_history_time=datetime.utcnow())
-thread_members = [member]
-chat_thread_client.add_members(thread_members)
+thread_participants = [participant]
+chat_thread_client.add_participants(thread_participants)
 ```
 
-### Remove thread member
+### Remove thread participant
 
-Use `remove_member` method to remove thread member from the thread identified by threadId.
+Use `remove_participant` method to remove thread participant from the thread identified by threadId.
 `user` is the `CommunicationUserIdentifier` you created by CommunicationIdentityClient.create_user() from User Access Tokens
 <!-- [User Access Tokens](#user-access-tokens)  -->
 and was added into this chat thread.
 
 ```python
-chat_thread_client.remove_member(user)
+chat_thread_client.remove_participant(user)
 ```
 
 ## Events Operations
@@ -350,10 +386,10 @@ chat_thread_client.send_read_receipt(message_id)
 
 `list_read_receipts` method retrieves read receipts for a thread.
 
-An iterator of `[ReadReceipt]` is the response returned from listing read receipts
+An iterator of `[ChatMessageReadReceipt]` is the response returned from listing read receipts
 
 ```python
-read_receipts = chat_thread_client.list_read_receipts()
+read_receipts = chat_thread_client.list_read_receipts(results_per_page=5, skip=5)
 for read_receipt in read_receipts:
     print(read_receipt)
     print(read_receipt.sender)

diff --git a/sdk/communication/azure-communication-chat/azure/communication/chat/__init__.py b/sdk/communication/azure-communication-chat/azure/communication/chat/__init__.py
@@ -2,32 +2,34 @@
 from ._chat_client import ChatClient
 from ._chat_thread_client import ChatThreadClient
 from ._generated.models import (
-    ChatMessagePriority,
     SendChatMessageResult,
     ChatThreadInfo,
+    ChatMessageType
 )
 from ._shared.user_credential import CommunicationTokenCredential
 from ._shared.user_token_refresh_options import CommunicationTokenRefreshOptions
 from ._models import (
-    ChatThreadMember,
+    ChatThreadParticipant,
     ChatMessage,
     ChatThread,
-    ReadReceipt,
+    ChatMessageReadReceipt,
+    ChatMessageContent
 )
 from ._shared.models import CommunicationUserIdentifier
 
 __all__ = [
     'ChatClient',
     'ChatThreadClient',
     'ChatMessage',
-    'ChatMessagePriority',
-    'ReadReceipt',
+    'ChatMessageContent',
+    'ChatMessageReadReceipt',
     'SendChatMessageResult',
     'ChatThread',
     'ChatThreadInfo',
     'CommunicationTokenCredential',
     'CommunicationTokenRefreshOptions',
-    'ChatThreadMember',
     'CommunicationUserIdentifier',
+    'ChatThreadParticipant',
+    'ChatMessageType'
 ]
 __version__ = VERSION