Skip to content

Commit 930acb7

Browse files
authored
Merge pull request #206 from david-lev/dev
update docs
2 parents dbc2261 + 254e084 commit 930acb7

23 files changed

Lines changed: 1137 additions & 749 deletions

README.md

Lines changed: 251 additions & 242 deletions
Large diffs are not rendered by default.

docs/source/content/client/client_reference.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Client Reference
1111
.. automethod:: WhatsApp.send_document
1212
.. automethod:: WhatsApp.send_location
1313
.. automethod:: WhatsApp.request_location
14+
.. automethod:: WhatsApp.request_contact_info
1415
.. automethod:: WhatsApp.send_contact
1516
.. automethod:: WhatsApp.send_sticker
1617
.. automethod:: WhatsApp.send_catalog
@@ -50,6 +51,8 @@ Client Reference
5051
.. automethod:: WhatsApp.get_templates
5152
.. automethod:: WhatsApp.delete_template
5253
.. automethod:: WhatsApp.unpause_template
54+
.. automethod:: WhatsApp.archive_templates
55+
.. automethod:: WhatsApp.unarchive_templates
5356
.. automethod:: WhatsApp.compare_templates
5457
.. automethod:: WhatsApp.migrate_templates
5558
.. automethod:: WhatsApp.create_flow

docs/source/content/client/overview.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ The client allows you to send a wide variety of messages:
7474
- Share a location
7575
* - :meth:`~WhatsApp.request_location`
7676
- Request location from a user
77+
* - :meth:`~WhatsApp.request_contact_info`
78+
- Request contact information from a user
7779
* - :meth:`~WhatsApp.send_contact`
7880
- Send one or multiple contacts
7981
* - :meth:`~WhatsApp.send_sticker`
@@ -236,6 +238,10 @@ Create, update, and manage message templates:
236238
- Delete a template
237239
* - :meth:`~WhatsApp.unpause_template`
238240
- Unpause a previously paused template
241+
* - :meth:`~WhatsApp.archive_templates`
242+
- Archive one or multiple templates
243+
* - :meth:`~WhatsApp.unarchive_templates`
244+
- Unarchive one or multiple templates
239245
* - :meth:`~WhatsApp.compare_templates`
240246
- Compare two templates
241247
* - :meth:`~WhatsApp.migrate_templates`

docs/source/content/errors/username_errors.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ Username Errors
1313
:show-inheritance:
1414
.. autoclass:: IGAccountNotLinked()
1515
:show-inheritance:
16+
.. autoclass:: UsernameTransferRequired()
17+
:show-inheritance:

docs/source/content/filters/common_filters.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Common filters
2828
.. autofunction:: sent_to
2929
.. autoattribute:: pywa.filters.sent_to_me
3030
.. autofunction:: from_users
31+
.. autofunction:: no_wa_id
3132
.. autofunction:: from_countries
3233
.. autofunction:: matches
3334
.. autofunction:: contains

docs/source/content/handlers/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Then load that module when creating the client:
118118
.. code-block:: python
119119
:caption: main.py
120120
:linenos:
121-
:emphasize-lines: 2, 5
121+
:emphasize-lines: 2, 6
122122
123123
from pywa import WhatsApp
124124
from . import my_handlers # Import the module that holds the handlers

docs/source/content/updates/common_methods.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ Common methods
88

99
.. autoclass:: BaseUserUpdate()
1010
:members: sender, recipient, message_id_to_reply,
11-
reply_text, reply_image, reply_video, reply_audio, reply_voice, reply_document, reply_location, reply_location_request,
11+
reply_text, reply_image, reply_video, reply_audio, reply_voice, reply_document, reply_location, reply_contact_info_request, reply_location_request,
1212
reply_contact, reply_sticker, reply_template, reply_catalog, reply_product, reply_products, reply_carousel, react, unreact,
1313
mark_as_read, indicate_typing, block_sender, unblock_sender, call

docs/source/content/updates/outgoing_edited_message.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Outgoing Edited Message
66
The :class:`~OutgoingMessage` update is triggered when a message is sent from the business. It contains information about the message being sent, including its content and metadata.
77

88

9-
.. autoclass:: OutgoingMessage()
9+
.. autoclass:: OutgoingEditedMessage()

docs/source/content/updates/overview.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,8 @@ All updates share common methods and properties:
165165
- Reply with a location message
166166
* - :meth:`~BaseUserUpdate.reply_location_request`
167167
- Request the user’s location
168+
* :meth:`~BaseUserUpdate.reply_contact_info_request`
169+
- Request the user’s contact info
168170
* - :meth:`~BaseUserUpdate.reply_contact`
169171
- Reply with a contact message
170172
* - :meth:`~BaseUserUpdate.reply_sticker`

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ See the full changelog `here <content/changelog.html>`_.
3636
/content/groups/overview
3737
/content/calls/overview
3838
/content/examples/overview
39+
/content/cli
3940
/content/changelog
4041
/content/contributing
4142
/content/migration

0 commit comments

Comments
 (0)