deploy: 6eed7e9

NooraHealth · Dec 22, 2023 · b75b3ce · b75b3ce
commit b75b3ce
Show file tree

Hide file tree

Showing 112 changed files with 17,150 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: fdee670c1f07dde700bee0a8dbbacb45
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/exceptions.doctree b/.doctrees/exceptions.doctree
diff --git a/.doctrees/exotel.doctree b/.doctrees/exotel.doctree
diff --git a/.doctrees/exotelpy.exceptions.doctree b/.doctrees/exotelpy.exceptions.doctree
diff --git a/.doctrees/exotelpy.exotel.Exotel.doctree b/.doctrees/exotelpy.exotel.Exotel.doctree
diff --git a/.doctrees/exotelpy.exotel.Retry.doctree b/.doctrees/exotelpy.exotel.Retry.doctree
diff --git a/.doctrees/exotelpy.exotel.Schedule.doctree b/.doctrees/exotelpy.exotel.Schedule.doctree
diff --git a/.doctrees/exotelpy.validators.doctree b/.doctrees/exotelpy.validators.doctree
diff --git a/.doctrees/exotelpy/exotelpy.exceptions.doctree b/.doctrees/exotelpy/exotelpy.exceptions.doctree
diff --git a/.doctrees/exotelpy/exotelpy.exotel.Exotel.doctree b/.doctrees/exotelpy/exotelpy.exotel.Exotel.doctree
diff --git a/.doctrees/exotelpy/exotelpy.exotel.Retry.doctree b/.doctrees/exotelpy/exotelpy.exotel.Retry.doctree
diff --git a/.doctrees/exotelpy/exotelpy.exotel.Schedule.doctree b/.doctrees/exotelpy/exotelpy.exotel.Schedule.doctree
diff --git a/.doctrees/exotelpy/exotelpy.validators.doctree b/.doctrees/exotelpy/exotelpy.validators.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/retry.doctree b/.doctrees/retry.doctree
diff --git a/.doctrees/schedule.doctree b/.doctrees/schedule.doctree
diff --git a/.doctrees/validators.doctree b/.doctrees/validators.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_sources/exceptions.rst.txt b/_sources/exceptions.rst.txt
@@ -0,0 +1,8 @@
+---------------------
+Exceptions
+---------------------
+
+.. automodule:: exotelpy.exceptions
+   :show-inheritance:
+   :members:
+   :member-order: bysource
diff --git a/_sources/exotel.rst.txt b/_sources/exotel.rst.txt
@@ -0,0 +1,58 @@
+---------------------
+Exotel
+---------------------
+
+.. currentmodule:: exotelpy.exotel
+
+.. IMPORTANT::
+   Please refer to linked `Exotel API docs <https://developer.exotel.com/api/sms>`_ for more details
+
+.. autoclass:: Exotel
+
+
+   .. rubric:: Campaigns
+
+   .. automethod:: create_campaign
+   .. automethod:: create_campaign_with_list
+   .. automethod:: get_campaign_details
+   .. automethod:: delete_campaign
+   .. automethod:: get_campaign_call_details
+   .. automethod:: get_bulk_campaign_details
+
+
+   .. rubric:: Contacts
+   .. automethod:: create_contacts
+   .. automethod:: get_contact_details
+   .. automethod:: delete_contact
+   .. automethod:: delete_contacts
+
+
+   .. rubric:: Lists
+   .. automethod:: create_list
+   .. automethod:: add_contacts_to_list
+   .. automethod:: delete_list
+   .. automethod:: get_list_details
+   .. automethod:: get_bulk_lists
+   .. automethod:: get_list_contacts
+
+
+   .. rubric:: SMS Campaigns
+   .. DANGER::
+      SMS Campaign Methods will be soon deprecated as Exotel has deprecated the endpoint
+   .. automethod:: create_sms_campaign
+   .. automethod:: create_sms_campaign_with_list
+   .. automethod:: create_message_campaign
+   .. automethod:: create_message_campaign_with_list
+   .. automethod:: get_sms_campaign_details
+   .. automethod:: get_bulk_sms_campaign_details
+   .. automethod:: get_sms_campaign_sms_details
+
+
+   .. rubric:: SMS
+   .. automethod:: get_sms_details
+   .. automethod:: send_bulk_sms
+
+   .. rubric:: Exophones
+   .. automethod:: get_all_exophones
+   .. automethod:: get_exophone_details
+   .. automethod:: get_exophone_heartbeat
diff --git a/_sources/exotelpy.exceptions.rst.txt b/_sources/exotelpy.exceptions.rst.txt
@@ -0,0 +1,33 @@
+exotelpy.exceptions
+===================
+
+.. automodule:: exotelpy.exceptions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+
+      AuthenticationFailed
+      NotFound
+      PaymentRequired
+      PermissionDenied
+      PyexotelBaseException
+      Throttled
+      UniqueViolationError
+      ValidationError
+
+
diff --git a/_sources/exotelpy.exotel.Exotel.rst.txt b/_sources/exotelpy.exotel.Exotel.rst.txt
@@ -0,0 +1,50 @@
+exotelpy.exotel.Exotel
+========================
+
+.. currentmodule:: exotelpy.exotel
+
+.. autoclass:: Exotel
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Exotel.__init__
+      ~Exotel.add_contacts_to_list
+      ~Exotel.create_campaign
+      ~Exotel.create_campaign_with_list
+      ~Exotel.create_contacts
+      ~Exotel.create_list
+      ~Exotel.create_message_campaign
+      ~Exotel.create_message_campaign_with_list
+      ~Exotel.create_sms_campaign
+      ~Exotel.create_sms_campaign_with_list
+      ~Exotel.delete_campaign
+      ~Exotel.delete_contact
+      ~Exotel.delete_contacts
+      ~Exotel.delete_list
+      ~Exotel.get_all_exophones
+      ~Exotel.get_bulk_campaign_details
+      ~Exotel.get_bulk_lists
+      ~Exotel.get_bulk_sms_campaign_details
+      ~Exotel.get_campaign_call_details
+      ~Exotel.get_campaign_details
+      ~Exotel.get_contact_details
+      ~Exotel.get_exophone_details
+      ~Exotel.get_exophone_heartbeat
+      ~Exotel.get_list_contacts
+      ~Exotel.get_list_details
+      ~Exotel.get_sms_campaign_details
+      ~Exotel.get_sms_campaign_sms_details
+      ~Exotel.get_sms_details
+      ~Exotel.send_bulk_sms
+
+
+
+
+
+
diff --git a/_sources/exotelpy.exotel.Retry.rst.txt b/_sources/exotelpy.exotel.Retry.rst.txt
@@ -0,0 +1,30 @@
+exotelpy.exotel.Retry
+=======================
+
+.. currentmodule:: exotelpy.exotel
+
+.. autoclass:: Retry
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Retry.__init__
+      ~Retry.to_dict
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Retry.mechanism
+      ~Retry.on_status
+
+
diff --git a/_sources/exotelpy.exotel.Schedule.rst.txt b/_sources/exotelpy.exotel.Schedule.rst.txt
@@ -0,0 +1,30 @@
+exotelpy.exotel.Schedule
+==========================
+
+.. currentmodule:: exotelpy.exotel
+
+.. autoclass:: Schedule
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Schedule.__init__
+      ~Schedule.to_json
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Schedule.end_at
+      ~Schedule.send_at
+
+
diff --git a/_sources/exotelpy.validators.rst.txt b/_sources/exotelpy.validators.rst.txt
@@ -0,0 +1,27 @@
+exotelpy.validators
+===================
+
+.. automodule:: exotelpy.validators
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      validate_phone_number
+      validate_url
+
+
+
+
+
+
+
+
+
+
diff --git a/_sources/exotelpy/exotelpy.exceptions.rst.txt b/_sources/exotelpy/exotelpy.exceptions.rst.txt
@@ -0,0 +1,36 @@
+pyexotel.exceptions
+===================
+
+.. automodule:: pyexotel.exceptions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+
+      AuthenticationFailed
+      NotFound
+      PaymentRequired
+      PermissionDenied
+      PyexotelBaseException
+      Throttled
+      UniqueViolationError
+      ValidationError
+
+
+
+
+
diff --git a/_sources/exotelpy/exotelpy.exotel.Exotel.rst.txt b/_sources/exotelpy/exotelpy.exotel.Exotel.rst.txt
@@ -0,0 +1,50 @@
+exotelpy.exotel.Exotel
+========================
+
+.. currentmodule:: exotelpy.exotel
+
+.. autoclass:: Exotel
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Exotel.__init__
+      ~Exotel.add_contacts_to_list
+      ~Exotel.create_campaign
+      ~Exotel.create_campaign_with_list
+      ~Exotel.create_contacts
+      ~Exotel.create_list
+      ~Exotel.create_message_campaign
+      ~Exotel.create_message_campaign_with_list
+      ~Exotel.create_sms_campaign
+      ~Exotel.create_sms_campaign_with_list
+      ~Exotel.delete_campaign
+      ~Exotel.delete_contact
+      ~Exotel.delete_contacts
+      ~Exotel.delete_list
+      ~Exotel.get_all_exophones
+      ~Exotel.get_bulk_campaign_details
+      ~Exotel.get_bulk_lists
+      ~Exotel.get_bulk_sms_campaign_details
+      ~Exotel.get_campaign_call_details
+      ~Exotel.get_campaign_details
+      ~Exotel.get_contact_details
+      ~Exotel.get_exophone_details
+      ~Exotel.get_exophone_heartbeat
+      ~Exotel.get_list_contacts
+      ~Exotel.get_list_details
+      ~Exotel.get_sms_campaign_details
+      ~Exotel.get_sms_campaign_sms_details
+      ~Exotel.get_sms_details
+      ~Exotel.send_bulk_sms
+
+
+
+
+
+
diff --git a/_sources/exotelpy/exotelpy.exotel.Retry.rst.txt b/_sources/exotelpy/exotelpy.exotel.Retry.rst.txt
@@ -0,0 +1,30 @@
+exotelpy.exotel.Retry
+=======================
+
+.. currentmodule:: exotelpy.exotel
+
+.. autoclass:: Retry
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Retry.__init__
+      ~Retry.to_dict
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Retry.mechanism
+      ~Retry.on_status
+
+