rename all_articles to articles

pyotrs/lib.py

@@ -793,14 +793,17 @@ class Client(object):
         * ticket_get_by_number
     """
 
-    def ticket_get_by_id(self, ticket_id, dynamic_fields=True, all_articles=False):
+    def ticket_get_by_id(self,
+                         ticket_id,
+                         dynamic_fields=True,
+                         articles=False):
         """ticket_get_by_id
 
         Args:
             ticket_id (int): Integer value of a Ticket ID
             dynamic_fields (bool): will request OTRS to include all
                 Dynamic Fields (*default: True*)
-            all_articles (bool): will request OTRS to include all
+            articles (bool): will request OTRS to include all
                 Articles (+default: False*)
 
         Returns:
@@ -813,20 +816,23 @@ class Client(object):
         payload = {
             "SessionID": self.session_id_store.value,
             "TicketID": "{}".format(ticket_id),
-            "AllArticles": int(all_articles),
+            "AllArticles": int(articles),
             "DynamicFields": int(dynamic_fields)
         }
 
         return self._ticket_get_json(url, payload)
 
-    def ticket_get_by_ids(self, ticket_id_list, dynamic_fields=True, all_articles=False):
+    def ticket_get_by_ids(self,
+                          ticket_id_list,
+                          dynamic_fields=True,
+                          articles=False):
         """ticket_get_by_ids
 
         Args:
             ticket_id_list (list): List of Integer value
             dynamic_fields (bool): will request OTRS to include all
                 Dynamic Fields (*default: True*)
-            all_articles (bool): will request OTRS to include all
+            articles (bool): will request OTRS to include all
                 Articles (*default: False*)
 
         Returns:
@@ -839,20 +845,23 @@ class Client(object):
         payload = {
             "SessionID": self.session_id_store.value,
             "TicketID": ','.join([str(item) for item in ticket_id_list]),
-            "AllArticles": int(all_articles),
+            "AllArticles": int(articles),
             "DynamicFields": int(dynamic_fields)
         }
 
         return self._ticket_get_json(url, payload)
 
-    def ticket_get_by_number(self, ticket_number, dynamic_fields=True, all_articles=False):
+    def ticket_get_by_number(self,
+                             ticket_number,
+                             dynamic_fields=True,
+                             articles=False):
         """ticket_get_by_number
 
         Args:
             ticket_number (unicode): Integer value of a Ticket ID
             dynamic_fields (bool): will request OTRS to include all
                     Dynamic Fields (*default: True*)
-            all_articles (bool): will request OTRS to include all
+            articles (bool): will request OTRS to include all
                     Articles (*default: False*)
 
         Returns:
@@ -869,7 +878,7 @@ class Client(object):
             tid = result_list[0]
             return self.ticket_get_by_id(tid,
                                          dynamic_fields=dynamic_fields,
-                                         all_articles=all_articles)
+                                         articles=articles)
         else:
             raise TicketSearchNumberMultipleResults("Found more that one result for "
                                                     "Ticket Number: {0}".format(ticket_number))