{
    "info": {
        "author": "Typeform",
        "author_email": "michael.solati@typeform.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7"
        ],
        "description": "# typeform\n\n[![PyPI version](https://badge.fury.io/py/typeform.svg)](https://badge.fury.io/py/typeform) [![Build Status](https://travis-ci.org/MichaelSolati/typeform-python-sdk.svg?branch=master)](https://travis-ci.org/MichaelSolati/typeform-python-sdk) [![Coverage Status](https://coveralls.io/repos/github/MichaelSolati/typeform-python-sdk/badge.svg?branch=master)](https://coveralls.io/github/MichaelSolati/typeform-python-sdk?branch=master)\n\nPython Client wrapper for [Typeform API](https://developer.typeform.com/)\n\n## Table of contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Initialize](#initialize)\n- [Reference](#reference)\n  - [Create Client](#typeformapi_key)\n  - [Forms](#forms)\n  - [Responses](#responses)\n\n## Installation\n\n``` bash\npip install typeform\n```\n\n## Usage\n\n### Initialize\n\n1 - Import client library\n\n``` python\n  from typeform import Typeform\n```\n\n2 - Create an instance with your personal token\n\n``` python\n  typeform = Typeform('<api_key>')\n```\n\n3 - Use any of the methods available in the [reference](#reference)\n\n``` python\n  # will retrieve all forms\n  forms: dict = typeform.forms.list()\n```\n\n## Reference\n\n### `Typeform('<api_key>')`\n\n- Creates a new instance of Typeform's Python client\n- Returns an instance with the methods described below\n\n``` python\n  typeform = Typeform('<api_key>')\n```\n\nClient returns the following properties:\n\n- `forms`\n- `responses`\n\nEach one of them encapsulates the operations related to it (like listing, updating, deleting the resource).\n\n### Forms\n\n#### `forms.create(data: dict = {})`\n\nCreates a form. Returns `dict` of created form. [See docs](https://developer.typeform.com/create/reference/create-form/).\n\n```python\nforms = Typeform('<api_key>').forms\nresult: dict = forms.create({ 'title': 'Hello World' })\n```\n\n#### `forms.delete(uid: str)`\n\nDeletes the form with the given form_id and all of the form's responses. Returns a `str` based on success of deletion, `OK` on success, otherwise an error message. [See docs](https://developer.typeform.com/create/reference/delete-form/).\n\n```python\nforms = Typeform('<api_key>').forms\nresult: str = forms.delete('abc123')\n```\n\n#### `forms.get(uid: str)`\n\nRetrieves a form by the given form_id. Includes any theme and images attached to the form as references. [See docs](https://developer.typeform.com/create/reference/retrieve-form/).\n\n```python\nforms = Typeform('<api_key>').forms\nresult: dict = forms.get('abc123')\n```\n\n#### `forms.list(page: int = None, pageSize: int = None, search: str = None, workspaceId: str = None)`\n\nRetrieves a list of JSON descriptions for all forms in your Typeform account (public and private). Forms are listed in reverse-chronological order based on the last date they were modified. [See docs](https://developer.typeform.com/create/reference/retrieve-form/).\n\n```python\nforms = Typeform('<api_key>').forms\nresult: dict = forms.list()\n```\n\n#### `forms.update(uid: str, patch: bool = False, data: dict = {})`\n\nUpdates an existing form. Defaults to `put`. `put` will return the modified form as a `dict` object. `patch` will Returns a `str` based on success of change, `OK` on success, otherwise an error message. [See `put` docs](https://developer.typeform.com/create/reference/update-form/) or [`patch` docs](https://developer.typeform.com/create/reference/update-form-patch/).\n\n```python\nforms = Typeform('<api_key>').forms\nresult: dict = forms.update('abc123', { 'title': 'Hello World, Again' })\nresult: str = forms.update('abc123', { 'title': 'Hello World, Again' }, patch=True)\n```\n\n#### `forms.messages.get(uid: str)`\n\nRetrieves the customizable messages for a form (specified by form_id) using the form's specified language. You can format messages with bold (*bold*) and italic (_italic_) text. HTML tags are forbidden. [See docs](https://developer.typeform.com/create/reference/retrieve-custom-form-messages/).\n\n```python\nforms = Typeform('<api_key>').forms\nresult: dict = forms.messages.get('abc123')\n```\n\n#### `forms.messages.update(uid: str, data={})`\n\nSpecifies new values for the customizable messages in a form (specified by form_id). You can format messages with bold (*bold*) and italic (_italic_) text. HTML tags are forbidden. Returns a `str` based on success of change, `OK` on success, otherwise an error message. [See docs](https://developer.typeform.com/create/reference/update-custom-messages/).\n\n```python\nforms = Typeform('<api_key>').forms\nresult: str = forms.messages.update('abc123', {\n  'label.buttonHint.default': 'New Button Hint'\n})\n```\n\n### Responses\n\n#### `responses.list(uid: str, pageSize: int = None, since: str = None, until: str = None, after: str = None, before: str = None, includedResponseIds: str = None, completed: bool = None, sort: str = None, query: str = None, fields: List[str] = None)`\n\nReturns form responses and date and time of form landing and submission. [See docs](https://developer.typeform.com/responses/reference/retrieve-responses/).\n\n```python\nresponses = Typeform('<api_key>').responses\nresult: dict = responses.list('abc123')\n```\n\n#### `responses.delete(uid: str, includedTokens: Union[str, List[str]])`\n\nDelete responses to a form. You must specify the `included_tokens` parameter. Returns a `str` based on success of deletion, `OK` on success, otherwise an error message. [See docs](https://developer.typeform.com/responses/reference/delete-responses/).\n\n```python\nresponses = Typeform('<api_key>').responses\nresult: str = responses.delete('abc123' 'token1')\nresult: str = responses.delete('abc123' ['token2', 'token3'])\n```\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/MichaelSolati/typeform-python-sdk",
        "keywords": "type,form,typeform,api",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "typeform",
        "package_url": "https://pypi.org/project/typeform/",
        "platform": "",
        "project_url": "https://pypi.org/project/typeform/",
        "project_urls": {
            "Homepage": "https://github.com/MichaelSolati/typeform-python-sdk"
        },
        "release_url": "https://pypi.org/project/typeform/1.1.0/",
        "requires_dist": [
            "requests"
        ],
        "requires_python": "",
        "summary": "Python Client wrapper for Typeform API",
        "version": "1.1.0",
        "yanked": false,
        "yanked_reason": null
    },
    "last_serial": 6030836,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2224b395c64bcc6b9424d90c60ee3ea7",
                    "sha256": "ff480c44f921d17d097a0fa795039f4047a10946e26c8d56bda785c2e0ee5247"
                },
                "downloads": -1,
                "filename": "typeform-0.1.0-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "2224b395c64bcc6b9424d90c60ee3ea7",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": null,
                "size": 10996,
                "upload_time": "2017-02-24T14:17:01",
                "upload_time_iso_8601": "2017-02-24T14:17:01.109284Z",
                "url": "https://files.pythonhosted.org/packages/9c/a0/a4cf2e3ed9dbc04a6f1cd59279ae31683e66d69485217e7299df6d54c8b0/typeform-0.1.0-py2-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "c2289e262db17339cde543ae32471601",
                    "sha256": "fe2d95a0884adf339a9c883a315366c3b0e56603483b3964566927d20efd525a"
                },
                "downloads": -1,
                "filename": "typeform-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c2289e262db17339cde543ae32471601",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 10997,
                "upload_time": "2017-02-24T14:17:44",
                "upload_time_iso_8601": "2017-02-24T14:17:44.660277Z",
                "url": "https://files.pythonhosted.org/packages/6c/49/f1ca373d51c4e94f7c567ab2a87c813f94091ac65576196df90f7518bfc5/typeform-0.1.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "cf244d920f3a22e522c39d4283608fb6",
                    "sha256": "81b1ad4413b79bc7f4044719b70a32947ee9ad09ea41f1a6aca021aef692025a"
                },
                "downloads": -1,
                "filename": "typeform-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "cf244d920f3a22e522c39d4283608fb6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7464,
                "upload_time": "2017-02-24T14:17:02",
                "upload_time_iso_8601": "2017-02-24T14:17:02.722162Z",
                "url": "https://files.pythonhosted.org/packages/74/02/991db94075e1b9e16e528927038dd2cc269699cac56372734688da80697c/typeform-0.1.0.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "117a5bd6922168d7fae507b570d374ee",
                    "sha256": "575f60c43858a8a983f8cc4738e629bf24e523e556c31878014cda2fc83688b8"
                },
                "downloads": -1,
                "filename": "typeform-0.1.1-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "117a5bd6922168d7fae507b570d374ee",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": null,
                "size": 11285,
                "upload_time": "2017-05-22T13:14:29",
                "upload_time_iso_8601": "2017-05-22T13:14:29.156802Z",
                "url": "https://files.pythonhosted.org/packages/a4/01/821953af19da6d370bac96f5edc0f121cb64b7e57652f6c82200a663c389/typeform-0.1.1-py2-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "058bf32f3aabb835dd23ce26ef7e0c4e",
                    "sha256": "2c5d1eee908da652e7ab43f132d4788ec30b873edb02065a29e404987f504a9a"
                },
                "downloads": -1,
                "filename": "typeform-0.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "058bf32f3aabb835dd23ce26ef7e0c4e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 11284,
                "upload_time": "2017-05-22T13:14:30",
                "upload_time_iso_8601": "2017-05-22T13:14:30.813699Z",
                "url": "https://files.pythonhosted.org/packages/96/55/d98df3bcc3e659b4f7d8bfc0b43b04b1394f2484ba4b35d803a1a9f1a3d2/typeform-0.1.1-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "0b36c8ab8701d7ee1a892a0fa4936631",
                    "sha256": "2a51c0336d747b659915d70dd82cd6fe5fe623ef1a044f600c2195b7b841388f"
                },
                "downloads": -1,
                "filename": "typeform-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "0b36c8ab8701d7ee1a892a0fa4936631",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7808,
                "upload_time": "2017-05-22T13:14:32",
                "upload_time_iso_8601": "2017-05-22T13:14:32.527948Z",
                "url": "https://files.pythonhosted.org/packages/0d/20/20f1865c5d4687313313b3bfb98ecb689cd1e854d71638c5cd0b56096b41/typeform-0.1.1.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0b77e83cb3e9ea335d4257af71d5ee69",
                    "sha256": "d1953136a9703816bbe6e098e2453fa9e555a2a7d2ff27da1462a48f4c70a050"
                },
                "downloads": -1,
                "filename": "typeform-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0b77e83cb3e9ea335d4257af71d5ee69",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 8981,
                "upload_time": "2019-02-21T21:03:00",
                "upload_time_iso_8601": "2019-02-21T21:03:00.203443Z",
                "url": "https://files.pythonhosted.org/packages/1e/58/a42b053e448815576fe78b74a2345fa1f17f0304e1887338f05f16247499/typeform-1.0.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "641ad1e011128ad6d89bd81eaa16748f",
                    "sha256": "9271ad183dc36352cba7fc8d24b1285315d6a9701b5380842e609c3a32dcaffd"
                },
                "downloads": -1,
                "filename": "typeform-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "641ad1e011128ad6d89bd81eaa16748f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6333,
                "upload_time": "2019-02-21T21:03:01",
                "upload_time_iso_8601": "2019-02-21T21:03:01.418773Z",
                "url": "https://files.pythonhosted.org/packages/85/ae/0c766e4b5d34949e0a21588d0c5cd8087576946103e4b6ea301ac78adbeb/typeform-1.0.0.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "98b1a8db6fb3ac79d3fe7c0716473b10",
                    "sha256": "0672562bf848eb1d6d06ee28007b45e78ba72950d3bb37d315c63bb82de69fad"
                },
                "downloads": -1,
                "filename": "typeform-1.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "98b1a8db6fb3ac79d3fe7c0716473b10",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 8996,
                "upload_time": "2019-02-21T21:16:49",
                "upload_time_iso_8601": "2019-02-21T21:16:49.115827Z",
                "url": "https://files.pythonhosted.org/packages/46/14/1d3d3b648bf25e5b61aedb6b831f0b0e08642bbe5f3463268ee92a7cad29/typeform-1.0.1-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "07d34f74ec98af43285e9bd6b9e5fe03",
                    "sha256": "c617ea33a4f92f16d1dd8aff986c5340386ee577f99303b5cd4e64eeecce0bc9"
                },
                "downloads": -1,
                "filename": "typeform-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "07d34f74ec98af43285e9bd6b9e5fe03",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6373,
                "upload_time": "2019-02-21T21:16:50",
                "upload_time_iso_8601": "2019-02-21T21:16:50.413905Z",
                "url": "https://files.pythonhosted.org/packages/10/c3/86658878e4c9a537e8f0f0d5e5f5298c0e2fc06b08a641f0eb6b357af521/typeform-1.0.1.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9b5ab4f23dd6e29d0e8856f730db2cec",
                    "sha256": "2572fa97342ef9a6a9ad397d340658d8aacbead395ea52201765f765361089fe"
                },
                "downloads": -1,
                "filename": "typeform-1.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "9b5ab4f23dd6e29d0e8856f730db2cec",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9098,
                "upload_time": "2019-02-22T18:56:44",
                "upload_time_iso_8601": "2019-02-22T18:56:44.122024Z",
                "url": "https://files.pythonhosted.org/packages/8a/eb/ba4dd5e57d61896f729b09aadae2e4efb3e126a09c99f8eee9c873de6f9b/typeform-1.0.2-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "ce22aa13540637fb6d052a136485b19c",
                    "sha256": "9da20d7ee6c61ef2ad053a61c71e9051edbddb58b08c04446b84a226aa163b45"
                },
                "downloads": -1,
                "filename": "typeform-1.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "ce22aa13540637fb6d052a136485b19c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6435,
                "upload_time": "2019-02-22T18:56:45",
                "upload_time_iso_8601": "2019-02-22T18:56:45.341752Z",
                "url": "https://files.pythonhosted.org/packages/3c/09/fb18a8b505be94d4605a061193954b2d9222fbcc53495e3e89d6889be056/typeform-1.0.2.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8fbe271533a613ad1d50c10832550677",
                    "sha256": "6309e5a232b6ae03a96d9d97c7767830211579d0e86a1b019f335a5b17ae0146"
                },
                "downloads": -1,
                "filename": "typeform-1.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "8fbe271533a613ad1d50c10832550677",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 11264,
                "upload_time": "2019-06-29T00:39:29",
                "upload_time_iso_8601": "2019-06-29T00:39:29.391802Z",
                "url": "https://files.pythonhosted.org/packages/fd/49/1605bb3bc54ece95cbdd9f2409c9f04e543ca86181e4a0eff58c5605407b/typeform-1.1.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b3570a8b2b7309487d84817018af3c7e",
                    "sha256": "15e2a096bc26c667e6f037788c2f59b60d13dee7c2945e7954a833052650cb0e"
                },
                "downloads": -1,
                "filename": "typeform-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "b3570a8b2b7309487d84817018af3c7e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8180,
                "upload_time": "2019-06-29T00:39:31",
                "upload_time_iso_8601": "2019-06-29T00:39:31.128827Z",
                "url": "https://files.pythonhosted.org/packages/ef/db/e99adb000318abe61fc193ddb984a4fafe34b547b55473fcc3b452141d7b/typeform-1.1.0.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "8fbe271533a613ad1d50c10832550677",
                "sha256": "6309e5a232b6ae03a96d9d97c7767830211579d0e86a1b019f335a5b17ae0146"
            },
            "downloads": -1,
            "filename": "typeform-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8fbe271533a613ad1d50c10832550677",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 11264,
            "upload_time": "2019-06-29T00:39:29",
            "upload_time_iso_8601": "2019-06-29T00:39:29.391802Z",
            "url": "https://files.pythonhosted.org/packages/fd/49/1605bb3bc54ece95cbdd9f2409c9f04e543ca86181e4a0eff58c5605407b/typeform-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "b3570a8b2b7309487d84817018af3c7e",
                "sha256": "15e2a096bc26c667e6f037788c2f59b60d13dee7c2945e7954a833052650cb0e"
            },
            "downloads": -1,
            "filename": "typeform-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b3570a8b2b7309487d84817018af3c7e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8180,
            "upload_time": "2019-06-29T00:39:31",
            "upload_time_iso_8601": "2019-06-29T00:39:31.128827Z",
            "url": "https://files.pythonhosted.org/packages/ef/db/e99adb000318abe61fc193ddb984a4fafe34b547b55473fcc3b452141d7b/typeform-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "vulnerabilities": []
}