{
    "info": {
        "author": "Oyku and Zeynel",
        "author_email": "zeynel.fxgx@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Topic :: Software Development :: Build Tools"
        ],
        "description": "onesignal\\_sdk\n==============\n\nA Python client library for `OneSignal <https://onesignal.com/>`__ API.\n\nTable of Contents\n-----------------\n\n-  `Installation <#installation>`__\n-  `Usage <*usage>`__\n\n   -  `Creating a service client <#creating-a-client>`__\n   -  `Creating a notification <#creating-a-notification>`__\n   -  `Sending push notification <#sending-push-notification>`__\n   -  `Cancelling a notification <#cancelling-a-notification>`__\n   -  `Viewing push notifications <#viewing-push-notifications>`__\n   -  `Viewing a push notification <#viewing-a-push-notification>`__\n   -  `Viewing apps <#viewing-apps>`__\n   -  `Creating an app <#creating-an-app>`__\n   -  `Updating an app <#updating-an-app>`__\n   -  `Viewing devices <#viewing-devices>`__\n   -  `Adding a device <#adding-a-device>`__\n   -  `Editing a device <#editing-a-device>`__\n   -  `CSV Export <#csv-export>`__\n   -  `Opening track <#opening-track>`__\n\nInstallation\n------------\n\n::\n\n    pip install onesignal_sdk\n\nUsage\n-----\n\n.. code:: python\n\n    import onesignal as onesignal_sdk\n\nCreating a client\n~~~~~~~~~~~~~~~~~\n\nYou can create a OneSignal Client as shown below. You can find your\nuser\\_auth\\_key and REST API Key (app\\_auth\\_key) on OneSignal\n``Account & API Keys`` page.\n\n.. code:: python\n\n    onesignal_client = onesignal_sdk.Client(user_auth_key=\"XXXXX\",\n                                        app_auth_key=\"XXXX\",\n                                        app_id=\"APPID\")\n\nYou can always create a Client with no credential and set them later:\n\n.. code:: python\n\n    onesignal_client = onesignal_sdk.Client()\n    onesignal_client.user_auth_key = \"XXXXX\"\n    onesignal_client.app_auth_key = \"XXXXX\"\n    onesignal_client.app_id = \"APPID\"\n\nCreating a notification\n~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n    new_notification = onesignal_sdk.Notification(post_body={\"contents\": {\"en\": \"Message\", \"tr\": \"Mesaj\"}})\n\nif you want to change contents later:\n\n.. code:: python\n\n    new_notification = onesignal_sdk.Notification(post_body={\"contents\": {\"en\": \"Message\", \"tr\": \"Mesaj\"}})\n    ...\n    ...\n    new_notification.post_body[\"content\"] = {\"en\": \"New message\"}\n\nYou can set filters, data, buttons and all of the fields available on\n`OneSignal\nDocumentation <https://documentation.onesignal.com/reference#create-notification>`__\nby updating ``post_body`` of notification:\n\n.. code:: python\n\n    new_notification.post_body[\"data\"] = {\"foo\": 123, \"bar\": \"foo\"}\n    new_notification.post_body[\"headings\"] = {\"en\": \"English Title\"}\n    new_notification.post_body[\"included_segments\"] = [\"Active Users\", \"Inactive Users\"]\n    new_notification.post_body[\"filters\"] = [\n        {\"field\": \"tag\", \"key\": \"level\", \"relation\": \"=\", \"value\": \"10\"},\n        {\"operator\": \"OR\"}, {\"field\": \"tag\", \"key\": \"level\", \"relation\": \"=\", \"value\": \"20\"}\n    ]\n\nSending push notification\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo can send a notification to Segments:\n\n.. code:: python\n\n    # create a onesignal client\n    onesignal_client = onesignal_sdk.Client(app_auth_key=\"XXXX\", app_id=\"APPID\")\n\n    # create a notification\n    new_notification = onesignal_sdk.Notification(post_body={\n        \"contents\": {\"en\": \"Message\", \"tr\": \"Mesaj\"},\n        \"included_segments\": [\"Active Users\"],\n        \"filters\": [{\"field\": \"tag\", \"key\": \"level\", \"relation\": \"=\", \"value\": \"10\"}]\n    })\n\n    # send notification, it will return a response\n    onesignal_response = onesignal_client.send_notification(new_notification)\n    print(onesignal_response.status_code)\n    print(onesignal_response.json())\n\nTo send a notification to specific devices:\n\n.. code:: python\n\n    onesignal_client = onesignal_sdk.Client(app_auth_key=\"XXXX\", app_id=\"APPID\")\n    new_notification = onesignal_sdk.Notification(post_body={\n        \"contents\": {\"en\": \"Message\"},\n        \"include_player_ids\": [\"id1\", \"id2\"],\n    })\n\n    # send notification, it will return a response\n    onesignal_response = onesignal_client.send_notification(new_notification)\n    print(onesignal_response.status_code)\n    print(onesignal_response.json())\n\nCancelling a notification\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n    onesignal_client = onesignal_sdk.Client(user_auth_key=\"XXXXX\",\n                                        app_auth_key=\"XXXX\",\n                                        app_id=\"APPID\")\n\n    onesignal_response = onesignal_client.cancel_notification(\"notification_id\")\n    print(onesignal_response.status_code)\n    print(onesignal_response.json())\n\nViewing push notifications\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n    onesignal_response = onesignal_client.view_notifications(query={\"limit\": 30, \"offset\": 0})\n    if onesignal_response.status_code == 200:\n        print(onesignal_response.json())\n\nViewing a push notification\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n    onesignal_response = onesignal_client.view_notification(\"notification_id\")\n    if onesignal_response.status_code == 200:\n        print(onesignal_response.json())\n\nViewing apps\n~~~~~~~~~~~~\n\n.. code:: python\n\n    onesignal_response = onesignal_client.view_apps()\n\nYou can also view a single app:\n\n.. code:: python\n\n    onesignal_response = onesignal_client.view_app(\"app_id\")\n\nCreating an app\n~~~~~~~~~~~~~~~\n\n.. code:: python\n\n    onesignal_client = onesignal_sdk.Client(user_auth_key=\"XXXXX\",\n                                        app_auth_key=\"XXXX\",\n                                        app_id=\"APPID\")\n\n    app_body = {\n        \"name\": \"Test App\",\n        \"apns_env\": \"production\"\n    }\n\n    onesignal_response = onesignal_client.create_app(app_body)\n    if onesignal_response.status_code == 200:\n        print(onesignal_response.json())\n\nUpdating an app\n~~~~~~~~~~~~~~~\n\n.. code:: python\n\n    onesignal_client = onesignal_sdk.Client(user_auth_key=\"XXXXX\",\n                                        app_auth_key=\"XXXX\",\n                                        app_id=\"APPID\")\n\n    app_body = {\n        \"name\": \"New App\",\n        \"gcm_key\": \"XX-XXX-XXXXX\"\n    }\n\n    onesignal_response = onesignal_client.update_app(app_id=\"XXXX\", app_body=app_body)\n    if onesignal_response.status_code == 200:\n        print(onesignal_response.json())\n\nViewing devices\n~~~~~~~~~~~~~~~\n\n.. code:: python\n\n    onesignal_response = onesignal_client.view_devices(query={\"limit\": 20})\n    if onesignal_response.status_code == 200:\n        print(onesignal_response.json())\n\nYou can also view a device:\n\n.. code:: python\n\n    onesignal_response = onesignal_client.view_device(\"device_id\")\n\nAdding a device\n~~~~~~~~~~~~~~~\n\n.. code:: python\n\n    onesignal_client = onesignal_sdk.Client(user_auth_key=\"XXXXX\",\n                                        app_auth_key=\"XXXX\",\n                                        app_id=\"APPID\")\n\n    device_body = {\n        \"device_type\": 1,\n        \"language\": \"tr\"\n    }\n\n    onesignal_response = onesignal_client.create_device(device_body=device_body)\n\nEditing a device\n~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n    onesignal_client = onesignal_sdk.Client(user_auth_key=\"XXXXX\",\n                                        app_auth_key=\"XXXX\",\n                                        app_id=\"APPID\")\n\n    device_body = {\n        \"device_type\": 1,\n        \"language\": \"en\"\n    }\n\n    onesignal_response = onesignal_client.update_device(device_id=\"device_id\", device_body=device_body)\n\nCSV Export\n~~~~~~~~~~\n\n.. code:: python\n\n    onesignal_response = onesignal_client.csv_export(post_body={\"extra_fields\": [\"location\"]})\n    if onesignal_response.status_code == 200:\n        print(onesignal_response.json())\n\nOpening track\n~~~~~~~~~~~~~\n\n.. code:: python\n\n    onesignal_response = onesignal_client.track_open(\"notification_id\", track_body={\"opened\": True})\n\nLicence\n-------\n\nThis project is under the MIT license.\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/zeyneloz/onesignal_sdk",
        "keywords": "onesignal onesignal-api one-signal push-notification",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "onesignal-sdk",
        "package_url": "https://pypi.org/project/onesignal-sdk/",
        "platform": "",
        "project_url": "https://pypi.org/project/onesignal-sdk/",
        "project_urls": {
            "Homepage": "https://github.com/zeyneloz/onesignal_sdk"
        },
        "release_url": "https://pypi.org/project/onesignal-sdk/1.0.0/",
        "requires_dist": [
            "requests",
            "check-manifest ; extra == 'dev'",
            "coverage ; extra == 'test'"
        ],
        "requires_python": "",
        "summary": "A Python wrapper around the OneSignal API",
        "version": "1.0.0"
    },
    "last_serial": 4974696,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1afc275fba1b6bdbe53ee22ae2c0174e",
                    "sha256": "17951a6f22d3ffa46c03f6040dfee6315a16c80a4dff058a1e913c4c8fee6f88"
                },
                "downloads": -1,
                "filename": "onesignal_sdk-0.1.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "1afc275fba1b6bdbe53ee22ae2c0174e",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 9963,
                "upload_time": "2017-08-07T12:30:46",
                "url": "https://files.pythonhosted.org/packages/2e/17/ad36461a095da4f0f04ecc3a65a7eb27a62cffc5bb68fd16c1f7ee41a82b/onesignal_sdk-0.1.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "2d280465e918ecdfeca85c9a3d4592cd",
                    "sha256": "e5fa22870aac3fa85aa2fc6fdbe644fd95b58dda0cfa941155fd3ded35192b0a"
                },
                "downloads": -1,
                "filename": "onesignal_sdk-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "2d280465e918ecdfeca85c9a3d4592cd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7360,
                "upload_time": "2017-08-07T12:30:47",
                "url": "https://files.pythonhosted.org/packages/46/41/aa169f4e4211e341d2d4dcbbdaadd35aa39f1a1297619c2003c60f1ef27b/onesignal_sdk-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "da840a67f912ccb26386a7dc2e30fa18",
                    "sha256": "cb0b4eaaa1be6ef0c52abceb8ae410e589268268b2c1302ead480baa3dd08a09"
                },
                "downloads": -1,
                "filename": "onesignal_sdk-0.1.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "da840a67f912ccb26386a7dc2e30fa18",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 9976,
                "upload_time": "2017-08-07T12:47:13",
                "url": "https://files.pythonhosted.org/packages/90/70/eee62c3678f1f40be8212d0e7946178912e6c64da62e264039fa4c484bbd/onesignal_sdk-0.1.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a4fc2052073ce0df7a5ab1c3bf4265c1",
                    "sha256": "9acab53382d1557824410a78c7ff1f25d2dc52d65f62bd95a2cb23cdf44278a9"
                },
                "downloads": -1,
                "filename": "onesignal_sdk-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "a4fc2052073ce0df7a5ab1c3bf4265c1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7351,
                "upload_time": "2017-08-07T12:47:14",
                "url": "https://files.pythonhosted.org/packages/df/91/948036b188e0ba77ad0fbe101b46ca82fc299446f0b2b7fa5b8ac4d91951/onesignal_sdk-0.1.1.tar.gz"
            }
        ],
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "35888733b715df8eb675fac9cfb3d180",
                    "sha256": "7f4e45b8486e0d12227ffe919ef8f6da9c150aa240e441089e2207f8983ae26e"
                },
                "downloads": -1,
                "filename": "onesignal_sdk-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "35888733b715df8eb675fac9cfb3d180",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 6947,
                "upload_time": "2019-03-22T23:31:27",
                "url": "https://files.pythonhosted.org/packages/a8/21/25e77350cbdaac031d1c2d1c516486905f19439655e91eeb2c000ee65336/onesignal_sdk-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "df05e0c4eee5e3fa7bac608a7ed5afb2",
                    "sha256": "45a5d9a41c20ee27afff5a33ac1a4631bae50b0b25646103e0bcab4e22dfa863"
                },
                "downloads": -1,
                "filename": "onesignal_sdk-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "df05e0c4eee5e3fa7bac608a7ed5afb2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6293,
                "upload_time": "2019-03-22T23:31:28",
                "url": "https://files.pythonhosted.org/packages/16/7c/8668b0ce2211230d5ad9e2fa5b58ad7b9c233076aca209bc2c6169347469/onesignal_sdk-1.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "35888733b715df8eb675fac9cfb3d180",
                "sha256": "7f4e45b8486e0d12227ffe919ef8f6da9c150aa240e441089e2207f8983ae26e"
            },
            "downloads": -1,
            "filename": "onesignal_sdk-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "35888733b715df8eb675fac9cfb3d180",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6947,
            "upload_time": "2019-03-22T23:31:27",
            "url": "https://files.pythonhosted.org/packages/a8/21/25e77350cbdaac031d1c2d1c516486905f19439655e91eeb2c000ee65336/onesignal_sdk-1.0.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "df05e0c4eee5e3fa7bac608a7ed5afb2",
                "sha256": "45a5d9a41c20ee27afff5a33ac1a4631bae50b0b25646103e0bcab4e22dfa863"
            },
            "downloads": -1,
            "filename": "onesignal_sdk-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "df05e0c4eee5e3fa7bac608a7ed5afb2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6293,
            "upload_time": "2019-03-22T23:31:28",
            "url": "https://files.pythonhosted.org/packages/16/7c/8668b0ce2211230d5ad9e2fa5b58ad7b9c233076aca209bc2c6169347469/onesignal_sdk-1.0.0.tar.gz"
        }
    ]
}