<!-- <p align="center">
<img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
</p> -->
# zvolv Python SDK
[]
[]
[]
[]
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Documentation
- [Docs site](https://www.zvolv.com/docs) - explore our docs site and learn more about Zvolv.
- [User Guide](https://github.com/zvolvapi/python-zvolv-sdk/blob/python-zvolv-sdk/UserGuide.md) - explore our user guide docs and learn more about sdk
## Getting started
### Installation
You can install the Zvolv Python SDK using the following command.
```
pip install zvolv_sdk
```
> Requires Python 3.7 or higher.
### Usage
The Zvolv Hyper automation platform offers several APIs to build apps. Each Zvolv API delivers part of the capabilities from the platform, so that you can pick just those that fit for your needs. This SDK offers a corresponding package for each of Zvolv’s APIs.
#### Generate Zvolv authentication token and create a form submission
Utilize Zvolv SDK to create and update form submissions by obtaining an authentication token through the client, with examples demonstrating the creation and subsequent update of a form submission for a specified form ID using input data
```python
import zvolv_sdk
# zvolv Application without credentials
client = zvolv_sdk.Client()
# zvolv Application with credentials
zvolv_user_id = 'your_id'
zvolv_password = 'your_password'
zvolv_domain = 'your_zvolv_domain'
client = zvolv_sdk.Client(zvolv_user_id,zvolv_password,zvolv_domain)
# Create form submission
form_id = 1150
input_data = {
"646": "Akshay",
"647": "CS",
"648": "Pune",
"649": "2023-12-24",
"OverrideMetaData": False
}
print(client.create_form_submission(form_id, input_data))
# update form sumission
form_id = 1150
form_submission_id = 1171
input_data = {
"646": "sandip",
"647": "CS",
"648": "Nashik",
"649": "2023-12-30",
"OverrideMetaData": False
}
print(client.update_form_submission(form_id,input_data,form_submission_id))
```
Here we also ensure that the response back from Zvolv is a successful one and that the message is the one we sent by using the `assert` statement.
### Authentication Endpoints
- Database ( `authentication.Database` )
- Delegated ( `authentication.Delegated` )
- Enterprise ( `authentication.Enterprise` )
- API Authorization - Get Token ( `authentication.GetToken`)
- Passwordless ( `authentication.Passwordless` )
- RevokeToken ( `authentication.RevokeToken` )
- Social ( `authentication.Social` )
- Users ( `authentication.Users` )
### Management Endpoints
- Actions() (`Zvolv().action`)
- AttackProtection() (`Zvolv().attack_protection`)
- Blacklists() ( `Zvolv().blacklists` )
- Branding() ( `Zvolv().branding` )
## Supported Version
Only the current MAJOR version of SDK is supported. New features, functionality, bug fixes, and security updates will only be added to the current MAJOR version.
A current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features. Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often). At the same time, there is no schedule for major or breaking release. Instead, we will communicate one quarter in advance the upcoming breaking change to allow customers to plan for the upgrade. We always recommend that all users run the latest available minor release for whatever major version is in use. We highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.
## Copyright and License
Copyright (c) 2018 The Python Packaging Authority
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Raw data
{
"_id": null,
"home_page": "",
"name": "zvapi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.0.1",
"maintainer_email": "",
"keywords": "zvolv,zvolv-api,web-api,sdk,rest-api-client",
"author": "Yogesh Jadhav",
"author_email": "support@zvolv.com",
"download_url": "https://files.pythonhosted.org/packages/0d/24/c9267e15e39a84a65021fe1fdcb4b65cdad593c59526cce38fceb9352f34/zvapi-0.0.2.tar.gz",
"platform": null,
"description": "<!-- <p align=\"center\">\n <img src=\"https://github.com/box/sdks/blob/master/images/box-dev-logo.png\" alt= \u201cbox-dev-logo\u201d width=\"30%\" height=\"50%\">\n</p> -->\n\n# zvolv Python SDK\n\n[]\n[]\n[]\n[]\n\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n\n## Documentation\n- [Docs site](https://www.zvolv.com/docs) - explore our docs site and learn more about Zvolv.\n- [User Guide](https://github.com/zvolvapi/python-zvolv-sdk/blob/python-zvolv-sdk/UserGuide.md) - explore our user guide docs and learn more about sdk\n\n\n## Getting started\n### Installation\nYou can install the Zvolv Python SDK using the following command.\n```\npip install zvolv_sdk\n```\n\n> Requires Python 3.7 or higher.\n\n### Usage\nThe Zvolv Hyper automation platform offers several APIs to build apps. Each Zvolv API delivers part of the capabilities from the platform, so that you can pick just those that fit for your needs. This SDK offers a corresponding package for each of Zvolv\u2019s APIs.\n\n#### Generate Zvolv authentication token and create a form submission \n\nUtilize Zvolv SDK to create and update form submissions by obtaining an authentication token through the client, with examples demonstrating the creation and subsequent update of a form submission for a specified form ID using input data\n\n```python\nimport zvolv_sdk\n\n# zvolv Application without credentials\n\nclient = zvolv_sdk.Client() \n\n# zvolv Application with credentials\n\nzvolv_user_id = 'your_id'\nzvolv_password = 'your_password'\nzvolv_domain = 'your_zvolv_domain'\nclient = zvolv_sdk.Client(zvolv_user_id,zvolv_password,zvolv_domain)\n\n# Create form submission \nform_id = 1150\ninput_data = {\n \"646\": \"Akshay\",\n \"647\": \"CS\",\n \"648\": \"Pune\",\n \"649\": \"2023-12-24\",\n \"OverrideMetaData\": False\n}\nprint(client.create_form_submission(form_id, input_data))\n\n# update form sumission\nform_id = 1150\nform_submission_id = 1171\ninput_data = {\n \"646\": \"sandip\",\n \"647\": \"CS\",\n \"648\": \"Nashik\",\n \"649\": \"2023-12-30\",\n \"OverrideMetaData\": False\n}\nprint(client.update_form_submission(form_id,input_data,form_submission_id))\n```\n\nHere we also ensure that the response back from Zvolv is a successful one and that the message is the one we sent by using the `assert` statement.\n\n### Authentication Endpoints\n\n- Database ( `authentication.Database` )\n- Delegated ( `authentication.Delegated` )\n- Enterprise ( `authentication.Enterprise` )\n- API Authorization - Get Token ( `authentication.GetToken`)\n- Passwordless ( `authentication.Passwordless` )\n- RevokeToken ( `authentication.RevokeToken` )\n- Social ( `authentication.Social` )\n- Users ( `authentication.Users` )\n\n\n### Management Endpoints\n\n- Actions() (`Zvolv().action`)\n- AttackProtection() (`Zvolv().attack_protection`)\n- Blacklists() ( `Zvolv().blacklists` )\n- Branding() ( `Zvolv().branding` )\n\n\n## Supported Version\n\nOnly the current MAJOR version of SDK is supported. New features, functionality, bug fixes, and security updates will only be added to the current MAJOR version.\n\nA current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features. Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often). At the same time, there is no schedule for major or breaking release. Instead, we will communicate one quarter in advance the upcoming breaking change to allow customers to plan for the upgrade. We always recommend that all users run the latest available minor release for whatever major version is in use. We highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.\n\n\n## Copyright and License\n\n Copyright (c) 2018 The Python Packaging Authority\n\n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n\n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n\n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Official Zvolv Python SDK",
"version": "0.0.2",
"project_urls": {
"Source": "https://github.com/yogeshjadhav22/python-sdk0.0.1"
},
"split_keywords": [
"zvolv",
"zvolv-api",
"web-api",
"sdk",
"rest-api-client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2969eada66bce90ae461f39fff92aee22f06224d1689c5b8c93be4bede060b0e",
"md5": "e8dab3fb91101dccaebbf9aa8ceb955f",
"sha256": "d81daceff6e778d660bed62b050959a1a07d77caae5e9a491a2a1d713c75e441"
},
"downloads": -1,
"filename": "zvapi-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8dab3fb91101dccaebbf9aa8ceb955f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0.1",
"size": 10013,
"upload_time": "2023-12-15T07:55:23",
"upload_time_iso_8601": "2023-12-15T07:55:23.150605Z",
"url": "https://files.pythonhosted.org/packages/29/69/eada66bce90ae461f39fff92aee22f06224d1689c5b8c93be4bede060b0e/zvapi-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d24c9267e15e39a84a65021fe1fdcb4b65cdad593c59526cce38fceb9352f34",
"md5": "9321f2c42b33cd9f072c98fbf6612d0e",
"sha256": "2bff87bd3bd1bdf4bb1bfc825c2252738af89f8d82137ba0109c4a7770b9359a"
},
"downloads": -1,
"filename": "zvapi-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "9321f2c42b33cd9f072c98fbf6612d0e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0.1",
"size": 8394,
"upload_time": "2023-12-15T07:55:25",
"upload_time_iso_8601": "2023-12-15T07:55:25.092518Z",
"url": "https://files.pythonhosted.org/packages/0d/24/c9267e15e39a84a65021fe1fdcb4b65cdad593c59526cce38fceb9352f34/zvapi-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 07:55:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yogeshjadhav22",
"github_project": "python-sdk0.0.1",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "zvapi"
}
JSON
