Update Documentation (#244)

* fix indentation warnings of sphinx-build

* update docs/ for new modules

* update README for narrowcast

Author: okue

README.rst

@@ -147,6 +147,39 @@ https://developers.line.biz/en/reference/messaging-api/#send-broadcast-message
 
     line_bot_api.broadcast(TextSendMessage(text='Hello World!'))
 
+narrowcast(self, messages, recipient=None, filter=None, limit=None, timeout=None)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sends a push message to multiple users specified by attributes (such as age, gender, OS, and region)
+or retargeting (audiences).
+
+https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message
+
+.. code:: python
+
+    line_bot_api.narrowcast(
+        messages=TextSendMessage(text='Hello World!'),
+        recipient=AudienceRecipient(group_id=5614991017776),
+        filter=Filter(demographic=AgeFilter(gte="age_35", lt="age_40")),
+        limit=Limit(max=10)
+    )
+
+get_progress_status_narrowcast(self, request_id, timeout=None)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Get progress status of narrowcast messages sent.
+
+https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status
+
+.. code:: python
+
+    narrowcast_progress = line_bot_api.get_progress_status_narrowcast(request_id)
+    assert narrowcast_progress.phase == 'succeeded'
+    print(narrowcast.success_count)
+    print(narrowcast.failure_count)
+    print(narrowcast.target_count)
+
+
 get\_profile(self, user\_id, timeout=None)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

docs/source/linebot.models.rst

@@ -22,6 +22,11 @@ linebot.models.events module
 
 .. automodule:: linebot.models.events
 
+linebot.models.filter module
+-----------------------------------
+
+.. automodule:: linebot.models.filter
+
 linebot.models.flex_message module
 -----------------------------------
 
@@ -37,11 +42,26 @@ linebot.models.insight module
 
 .. automodule:: linebot.models.insight
 
+linebot.models.limit module
+------------------------------
+
+.. automodule:: linebot.models.limit
+
 linebot.models.messages module
 ------------------------------
 
 .. automodule:: linebot.models.messages
 
+linebot.models.operator module
+-------------------------------
+
+.. automodule:: linebot.models.operator
+
+linebot.models.recipient module
+-------------------------------
+
+.. automodule:: linebot.models.recipient
+
 linebot.models.responses module
 -------------------------------
 

linebot/models/insight.py

@@ -122,14 +122,14 @@ def __init__(self, request_id=None, timestamp=None, delivered=None,
         :param str request_id: Request ID.
         :param int timestamp: UNIX timestamp for message delivery time.
         :param int delivered: Number of messages delivered. This property shows values
-        of less than 20.
+            of less than 20.
         :param int unique_impression: Number of people who opened the message,
-        meaning they displayed at least 1 bubble.
+            meaning they displayed at least 1 bubble.
         :param int unique_click: Number of people who opened any URL in the message.
         :param int unique_media_played: Number of people who started playing any video
-        or audio in the message.
+            or audio in the message.
         :param int unique_media_played_100_percent: Number of people who played the entirety of
-        any video or audio in the message.
+            any video or audio in the message.
         """
         super(MessageStatistics, self).__init__(**kwargs)
 
@@ -157,23 +157,23 @@ def __init__(self, seq=None, impression=None, media_played=None,
         :param int impression: Number of times the bubble was displayed.
         :param int media_played: Number of times audio or video in the bubble started playing.
         :param int media_played_25_percent: Number of times audio or video
-        in the bubble was played from start to 25%.
+            in the bubble was played from start to 25%.
         :param int media_played_50_percent: Number of times audio or video
-        in the bubble was played from start to 50%.
+            in the bubble was played from start to 50%.
         :param int media_played_75_percent: Number of times audio or video
-        in the bubble was played from start to 75%.
+            in the bubble was played from start to 75%.
         :param int media_played_100_percent: Number of times audio or video
-        in the bubble was played in its entirety.
+            in the bubble was played in its entirety.
         :param int unique_media_played: Number of people that started playing
-        audio or video in the bubble.
+            audio or video in the bubble.
         :param int unique_media_played_25_percent: Number of people that played
-        audio or video in the bubble from start to 25%.
+            audio or video in the bubble from start to 25%.
         :param int unique_media_played_50_percent: Number of people that played
-        audio or video in the bubble from start to 50%.
+            audio or video in the bubble from start to 50%.
         :param int unique_media_played_75_percent: Number of people that played
-        audio or video in the bubble from start to 75%.
+            audio or video in the bubble from start to 75%.
         :param int unique_media_played_100_percent: Number of people that played
-        audio or video in the bubble in its entirety.
+            audio or video in the bubble in its entirety.
         """
         super(MessageInsight, self).__init__(**kwargs)
 
@@ -203,7 +203,7 @@ def __init__(self, seq=None, url=None, click=None, unique_click=None,
         :param int click: Number of times the URL was opened.
         :param int unique_click: Number of people that opened the URL.
         :param int unique_click_of_request: Number of people who opened this url
-        through any link in the message.
+            through any link in the message.
         """
         super(ClickInsight, self).__init__(**kwargs)