Use str to represent object as string

guiajlopes · guiajlopes · commit f532fca3daef · 2019-04-09T11:31:40.000+02:00
diff --git a/examples/conversation_create_message.py b/examples/conversation_create_message.py
@@ -19,16 +19,8 @@
                                               'content': {'text': args['message']}})
 
     # Print the object information.
-    print('\nThe following information was returned as a Conversation List object:\n')
-    print('  message id   : %s' % msg.id)
-    print('  channel id   : %s' % msg.channelId)
-    print('  direction    : %s' % msg.direction)
-    print('  content      : %s' % msg.content)
-    print('  content      : %s' % msg.content)
-    print('  status       : %s' % msg.status)
-    print('  type         : %s' % msg.type)
-    print('  created date : %s' % msg.createdDatetime)
-    print('  updated date : %s' % msg.updatedDatetime)
+    print('The following information was returned as a Conversation List object:\n')
+    print(msg)
 
 except messagebird.client.ErrorException as e:
     print('\nAn error occured while requesting a Message object:\n')
diff --git a/examples/conversation_create_webhook.py b/examples/conversation_create_webhook.py
@@ -21,12 +21,8 @@
     })
 
     # Print the object information.
-    print('\nThe following information was returned as a Webhook object:\n')
-    print('  id            : %s' % webhook.id)
-    print('  events        : %s' % webhook.events)
-    print('  channel id    : %s' % webhook.channelId)
-    print('  created date  : %s' % webhook.createdDatetime)
-    print('  updated date  : %s' % webhook.updatedDatetime)
+    print('The following information was returned as a Webhook object:')
+    print(webhook)
 
 except messagebird.client.ErrorException as e:
     print('\nAn error occured while requesting a Webhook object:\n')
diff --git a/examples/conversation_delete_webhook.py b/examples/conversation_delete_webhook.py
@@ -13,7 +13,7 @@
     client.conversation_delete_webhook(args['webhookId'])
 
     # Print the object information.
-    print('\nWebhook has been deleted:\n')
+    print('Webhook has been deleted')
 
 except messagebird.client.ErrorException as e:
     print('\nAn error occured while requesting a Webhook object:\n')
diff --git a/examples/conversation_list.py b/examples/conversation_list.py
@@ -11,19 +11,12 @@
 
     conversationList = client.conversation_list()
 
-    itemIds = []
-    for msgItem in conversationList.items:
-        itemIds.append(msgItem.id)
-
     # Print the object information.
-    print('\nThe following information was returned as a Conversation List object:\n')
-    print('  conversation ids  : %s' % itemIds)
-    print('  offset       : %s' % conversationList.offset)
-    print('  limit        : %s' % conversationList.limit)
-    print('  totalCount   : %s' % conversationList.totalCount)
+    print('The following information was returned as a Conversation List object:')
+    print(conversationList)
 
 except messagebird.client.ErrorException as e:
-    print('\nAn error occured while requesting a Message object:\n')
+    print('An error occured while requesting a Message object:')
 
     for error in e.errors:
         print('  code        : %d' % error.code)
diff --git a/examples/conversation_list_messages.py b/examples/conversation_list_messages.py
@@ -12,16 +12,9 @@
 
     msg = client.conversation_list_messages(args['conversationId'])
 
-    itemIds = []
-    for msgItem in msg.items:
-        itemIds.append(msgItem.id)
-
     # Print the object information.
-    print('\nThe following information was returned as a Conversation Message List object:\n')
-    print('  message ids  : %s' % itemIds)
-    print('  offset       : %s' % msg.offset)
-    print('  limit        : %s' % msg.limit)
-    print('  totalCount   : %s' % msg.totalCount)
+    print('The following information was returned as a Conversation Message List object:')
+    print(msg)
 
 except messagebird.client.ErrorException as e:
     print('\nAn error occured while requesting a Conversation Message List object:\n')
diff --git a/examples/conversation_list_webhook.py b/examples/conversation_list_webhook.py
@@ -9,18 +9,11 @@
 try:
     client = messagebird.Client(args['accessKey'])
 
-    webhookList = client.conversation_list_webhooks()
-
-    itemIds = []
-    for msgItem in webhookList.items:
-        itemIds.append(msgItem.id)
+    webhook_list = client.conversation_list_webhooks()
 
     # Print the object information.
-    print('\nThe following information was returned as a Conversation Webhook List object:\n')
-    print('  conversation ids  : %s' % itemIds)
-    print('  offset       : %s' % webhookList.offset)
-    print('  limit        : %s' % webhookList.limit)
-    print('  totalCount   : %s' % webhookList.totalCount)
+    print('The following information was returned as a Conversation Webhook List object:')
+    print(webhook_list)
 
 except messagebird.client.ErrorException as e:
     print('\nAn error occured while requesting a Conversation Webhook List object:\n')
diff --git a/examples/conversation_read.py b/examples/conversation_read.py
@@ -13,14 +13,8 @@
     conversation = client.conversation_read(args['conversationId'])
 
     # Print the object information.
-    print('\nThe following information was returned as a Conversation object:\n')
-    print('  conversation id           : %s' % conversation.id)
-    print('  contact id                : %s' % conversation.contactId)
-    print('  messages total count      : %s' % conversation.messages.totalCount)
-    print('  status                    : %s' % conversation.status)
-    print('  created date time         : %s' % conversation.createdDatetime)
-    print('  updated date time         : %s' % conversation.updatedDatetime)
-    print('  last received date time   : %s' % conversation.lastReceivedDatetime)
+    print('The following information was returned as a Conversation object:')
+    print(conversation)
 
 except messagebird.client.ErrorException as e:
     print('\nAn error occured while requesting a Conversation object:\n')
diff --git a/examples/conversation_read_message.py b/examples/conversation_read_message.py
@@ -13,16 +13,8 @@
     msg = client.conversation_read_message(args['messageId'])
 
     # Print the object information.
-    print('\nThe following information was returned as a Conversation List object:\n')
-    print('  message id   : %s' % msg.id)
-    print('  channel id   : %s' % msg.channelId)
-    print('  direction    : %s' % msg.direction)
-    print('  content      : %s' % msg.content)
-    print('  content      : %s' % msg.content)
-    print('  status       : %s' % msg.status)
-    print('  type         : %s' % msg.type)
-    print('  created date : %s' % msg.createdDatetime)
-    print('  updated date : %s' % msg.updatedDatetime)
+    print('The following information was returned as a Conversation List object:')
+    print(msg)
 
 except messagebird.client.ErrorException as e:
     print('\nAn error occured while requesting a Message object:\n')
diff --git a/examples/conversation_read_webhook.py b/examples/conversation_read_webhook.py
@@ -13,12 +13,8 @@
     webhook = client.conversation_read_webhook(args['webhookId'])
 
     # Print the object information.
-    print('\nThe following information was returned as a Webhook object:\n')
-    print('  id            : %s' % webhook.id)
-    print('  events        : %s' % webhook.events)
-    print('  channel id    : %s' % webhook.channelId)
-    print('  created date  : %s' % webhook.createdDatetime)
-    print('  updated date  : %s' % webhook.updatedDatetime)
+    print('The following information was returned as a Webhook object:')
+    print(webhook)
 
 except messagebird.client.ErrorException as e:
     print('\nAn error occured while requesting a Webhook object:\n')
diff --git a/examples/conversation_start.py b/examples/conversation_start.py
@@ -18,17 +18,8 @@
          'content': {'text': args['textMessage']}})
 
     # Print the object information.
-    print('\nThe following information was returned as a Conversation object:\n')
-    print('  id                    : %s' % msg.id)
-    print('  contact id            : %s' % msg.contactId)
-    print('  contact               : %s' % msg.contact)
-    print('  last used channel id  : %s' % msg.lastUsedChannelId)
-    print('  channels              : %s' % msg.channels)
-    print('  messages              : %s' % msg.messages)
-    print('  status                : %s' % msg.status)
-    print('  createdDateTime       : %s' % msg.createdDateTime)
-    print('  updatedDateTime       : %s' % msg.updatedDateTime)
-    print('  lastReceivedDateTime  : %s' % msg.lastReceivedDateTime)
+    print('The following information was returned as a Conversation object:')
+    print(msg)
 
 except messagebird.client.ErrorException as e:
     print('\nAn error occured while requesting a Message object:\n')
diff --git a/examples/conversation_update.py b/examples/conversation_update.py
@@ -13,14 +13,8 @@
     conversation = client.conversation_update(args['conversationId'], {'status': 'active'})
 
     # Print the object information.
-    print('\nThe following information was returned as a Conversation object:\n')
-    print('  conversation id           : %s' % conversation.id)
-    print('  contact id                : %s' % conversation.contactId)
-    print('  messages total count      : %s' % conversation.messages.totalCount)
-    print('  status                    : %s' % conversation.status)
-    print('  created date time         : %s' % conversation.createdDatetime)
-    print('  updated date time         : %s' % conversation.updatedDatetime)
-    print('  last received date time   : %s' % conversation.lastReceivedDatetime)
+    print('The following information was returned as a Conversation object:')
+    print(conversation)
 
 except messagebird.client.ErrorException as e:
     print('\nAn error occured while requesting a Conversation object:\n')
diff --git a/messagebird/conversation.py b/messagebird/conversation.py
@@ -74,6 +74,18 @@ def lastReceivedDatetime(self):
     def lastReceivedDatetime(self, value):
         self._lastReceivedDatetime = self.value_to_time(value, '%Y-%m-%dT%H:%M:%SZ')
 
+    def __str__(self):
+        return "\n".join([
+            'id                   : %s' % self.id,
+            'contact id           : %s' % self.contactId,
+            'last used channel id : %s' % self.lastUsedChannelId,
+            'message total count  : %s' % self.messages.totalCount,
+            'status               : %s' % self.status,
+            'created date time    : %s' % self.createdDatetime,
+            'updated date time    : %s' % self.updatedDatetime,
+            'last received date   : %s' % self.lastReceivedDatetime,
+        ])
+
 
 class ConversationList(Base):
     def __init__(self):
@@ -92,4 +104,17 @@ def items(self, value):
         if isinstance(value, list):
             self._items = []
             for item in value:
-                self._items.append(Conversation().load(item))
+                self._items.append(Conversation().load(item))
+
+    def __str__(self):
+        item_ids = []
+        for msg_item in self._items:
+            item_ids.append(msg_item.id)
+
+        return "\n".join([
+            'items IDs  : %s' % item_ids,
+            'offset     : %s' % self.offset,
+            'limit      : %s' % self.limit,
+            'count      : %s' % self.count,
+            'totalCount : %s' % self.totalCount,
+        ])
diff --git a/messagebird/conversation_message.py b/messagebird/conversation_message.py
@@ -40,6 +40,18 @@ def updatedDatetime(self, value):
         if value is not None:
             self._updatedDatetime = self.value_to_time(value, '%Y-%m-%dT%H:%M:%SZ')
 
+    def __str__(self):
+        return "\n".join([
+            'message id        : %s' % self.id,
+            'channel id        : %s' % self.channelId,
+            'direction         : %s' % self.direction,
+            'status            : %s' % self.status,
+            'type              : %s' % self.type,
+            'content           : %s' % self.content,
+            'created date time : %s' % self._createdDatetime,
+            'updated date time : %s' % self._updatedDatetime
+        ])
+
 
 class ConversationMessageReference(Base):
     def __init__(self):
@@ -68,3 +80,16 @@ def items(self, value):
                 items.append(ConversationMessage().load(item))
 
         self._items = items
+
+    def __str__(self):
+        item_ids = []
+        for msg_item in self._items:
+            item_ids.append(msg_item.id)
+
+        return "\n".join([
+            'items IDs  : %s' % item_ids,
+            'offset     : %s' % self.offset,
+            'limit      : %s' % self.limit,
+            'count      : %s' % self.count,
+            'totalCount : %s' % self.totalCount,
+        ])
diff --git a/messagebird/conversation_webhook.py b/messagebird/conversation_webhook.py
@@ -32,6 +32,15 @@ def updatedDatetime(self):
     def updatedDatetime(self, value):
         self._updatedDatetime = self.value_to_time(value, '%Y-%m-%dT%H:%M:%SZ')
 
+    def __str__(self):
+        return "\n".join([
+            'id                : %s' % self.id,
+            'events            : %s' % self.events,
+            'channel id        : %s' % self.channelId,
+            'created date time : %s' % self.createdDatetime,
+            'updated date time : %s' % self.updatedDatetime
+        ])
+
 
 class ConversationWebhookList(Base):
     def __init__(self):
@@ -53,3 +62,16 @@ def items(self, value):
                 items.append(ConversationWebhook().load(item))
 
         self._items = items
+
+    def __str__(self):
+        item_ids = []
+        for item in self._items:
+            item_ids.append(item.id)
+
+        return "\n".join([
+            'items IDs  : %s' % item_ids,
+            'offset     : %s' % self.offset,
+            'limit      : %s' % self.limit,
+            'count      : %s' % self.count,
+            'totalCount : %s' % self.totalCount,
+        ])
