Updating README

Author: Josh Wolff

.idea/workspace.xml

@@ -23,8 +23,10 @@ This repository is the Python wrapper for our API. To see code snippets for seve
 8) Run the command `help(SpontitResource)` in Python for complete documentation.
 9) Or try an example! Check out the <a href="https://github.com/spontit/spontit-api-python-wrapper/blob/master/spontit/examples/examples.py">examples</a>.
 10) You can customize the image of the notification on the website, iPhone app, or via the API by setting the image for the respective channel. See the image example titled `create_new_channel_with_profile_image_and_push_to_it` in the <a href="https://github.com/spontit/spontit-api-python-wrapper/blob/master/spontit/examples/examples.py">examples</a>.
-11) To push to others, have them follow the channel to which you will push (e.g. share <a href="https://spontit.com">spontit.com/my_username</a>). You can see available invite options by calling `print(resource.get_channel(...))` and supply the channel name. See the functions titled `create_new_channel_and_get_invite_options` and `get_invite_options_for_my_main_account` in the <a href="https://github.com/spontit/spontit-api-python-wrapper/blob/master/spontit/examples/examples.py">examples</a>.
-12) <b>Spontit is more than just broadcasting. You can send pushes to specific users and push personalized content.</b> See how to do so at `simple_push_to_specific_followers_example` and `specific_followers_and_channel_example` in the <a href="https://github.com/spontit/spontit-api-python-wrapper/blob/master/spontit/examples/examples.py">examples</a>. You simply input a list of usernames and it will push to those users (provided they follow the specified channel). You can list the usernames of those who follow one of your specified channels. See an example of how to do so at `list_followers_example` and `list_followers_for_channel_example` in the <a href="https://github.com/spontit/spontit-api-python-wrapper/blob/master/spontit/examples/examples.py">examples</a>.  
+11) To push to others, you can do two things.<br>
+    a) Have them sign up with a known email or phone number. Then push to them directly using their email or phone number. They do not have to follow you in order to receive the push. See `simple_push_to_specific_phone_numbers_and_emails_example` for an example (in the <a href="https://github.com/spontit/spontit-api-python-wrapper/blob/master/spontit/examples/examples.py">examples</a> file).<br>
+    b) Have them follow the channel to which you will push (e.g. share <a href="https://spontit.com">spontit.com/my_username</a>). You can see available invite options by calling `print(resource.get_channel(...))` and supply the channel name. See the functions titled `create_new_channel_and_get_invite_options` and `get_invite_options_for_my_main_account` in the <a href="https://github.com/spontit/spontit-api-python-wrapper/blob/master/spontit/examples/examples.py">examples</a>.
+12) <b>Spontit is more than just broadcasting. You can send pushes to specific users and push personalized content.</b> See how to do so at `simple_push_to_specific_followers_example`, `simple_push_to_specific_phone_numbers_and_emails_example`, and `specific_followers_and_channel_example` in the <a href="https://github.com/spontit/spontit-api-python-wrapper/blob/master/spontit/examples/examples.py">examples</a>. You simply input a list of usernames and it will push to those users (provided they follow the specified channel) -- or input a list of phone numbers and emails (they do not have to follow the given channel; see part 4(a)). You can list the usernames of those who follow one of your specified channels. See an example of how to do so at `list_followers_example` and `list_followers_for_channel_example` in the <a href="https://github.com/spontit/spontit-api-python-wrapper/blob/master/spontit/examples/examples.py">examples</a>.  
 13) We are constantly working on expanding the functionality of Spontit. We GREATLY appreciate your input - feel free to <a href="https://github.com/spontit/spontit-api-python-wrapper/issues/new" target="_blank">add a feature request</a> on our Github. :smiley:
 
 ### Getting Started :white_check_mark:

README.md

@@ -39,6 +39,30 @@ def simple_push_to_specific_followers_example(self):
         print(response)
         return response
 
+    def simple_push_to_specific_phone_numbers_and_emails_example(self):
+        """
+        Sends a push notification to phone numbers and emails. We link the user account to the phone numbers and emails
+        defined, and then send a push via Spontit.
+        The users linked **do not have to follow your account** to receive the push notification.
+        They will have the option to follow you or report you for spam. If you are reported for spam multiple times,
+        your account will be restricted.
+        :return:
+        """
+        # TODO- Replace with a real phone number.
+        phone_numbers = ["+18005550101"]
+        # TODO- Replace with a real email.
+        emails = ['fake.email@fake.com']
+        response = self.__resource.push(
+            "Hello to other users!",
+            body="Add any phone numbers or emails to this push. Tell users to sign up on Spontit with the same "
+                 "phone number / email as they signed up with using your service. Then you can push directly to them.",
+            push_to_phone_numbers=phone_numbers,
+            push_to_emails=emails
+        )
+        print(f"Notification sent to:\nEmails: {str(emails)}\nPhone numbers: {str(phone_numbers)}")
+        print(response)
+        return response
+
     def list_followers_example(self):
         """
         Lists all your followers.
@@ -312,6 +336,7 @@ def do_everything(self):
             self.scheduled_push,
             self.immediate_expiration_push,
             self.simple_push_to_specific_followers_example,
+            self.simple_push_to_specific_phone_numbers_and_emails_example,
             self.list_followers_example,
             self.list_followers_for_channel_example,
             self.specific_followers_and_channel_example,
@@ -342,8 +367,11 @@ def do_everything(self):
 
 if __name__ == "__main__":
     # Try an example...
-    spontit_src = SpontitResource("my_username", "my_secret_key")
+    # Get your userId at spontit.com/profile
+    # Get your secretKey at spontit.com/secret_keys
+    spontit_src = SpontitResource("my_user_id", "my_secret_key")
     example_instance = Examples(spontit_src)
+
     push_response = example_instance.simple_push_example()
     print("Simple push example result: " + str(push_response))
 

build/lib/spontit/examples/examples.py

@@ -260,6 +260,8 @@ def push(self,
              ios_subtitle=None,
              body=None,
              push_to_followers=None,
+             push_to_phone_numbers=None,
+             push_to_emails=None,
              schedule_time_stamp=None,
              expiration=None,
              link=None,
@@ -276,6 +278,14 @@ def push(self,
         :param body: A body of up to 5000 characters to include for when the user opens the push notification. Currently
         only available for iOS.
         :param push_to_followers: The specific followers to send the push to. A list of strings of the userIds
+        :param push_to_phone_numbers: The specific users to push to, defined by the phone number they used to sign up.
+        You can still push to these users even if they don't follow you. However, they have the option to report you
+        for spam, and you could have your account restricted if multiple users do. They also have the option to follow
+        you directly from the push.
+        :param push_to_emails: The specific users to push to, defined by the email they used to sign up.
+        You can still push to these users even if they don't follow you. However, they have the option to report you
+        for spam, and you could have your account restricted if multiple users do. They also have the option to follow
+        you directly from the push.
         :param schedule_time_stamp: Schedule the push notification for a later time. Int, epoch timestamp.
         :param expiration: Length of time for which the notification should exist. Set to Expiration.
         :param link: A link to include in the notification. Appears once the user opens the notification.
@@ -316,7 +326,15 @@ def push(self,
 
         if push_to_followers is not None:
             assert type(push_to_followers) == list or type(push_to_followers) == set
-            payload["individualFollowers"] = list(push_to_followers)
+            payload["pushToFollowers"] = list(push_to_followers)
+
+        if push_to_phone_numbers is not None:
+            assert type(push_to_phone_numbers) == list or type(push_to_phone_numbers) == set
+            payload["pushToPhoneNumbers"] = list(push_to_phone_numbers)
+
+        if push_to_emails is not None:
+            assert type(push_to_emails) == list or type(push_to_emails) == set
+            payload["pushToEmails"] = list(push_to_emails)
 
         if schedule_time_stamp is not None:
             if type(schedule_time_stamp) is not int: