zscaler-sdk-python 1.0.0__tar.gz

zscaler_sdk_python-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 [Zscaler](https://github.com/zscaler)
+
+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.

zscaler_sdk_python-1.0.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.1
+Name: zscaler-sdk-python
+Version: 1.0.0
+Summary: Framework for interacting with Zscaler Cloud via API
+Home-page: https://github.com/zscaler/zscaler-sdk-python
+License: MIT
+Keywords: zscaler,zpa,zia,zscaler-sdk-python
+Author: Zscaler Technology Alliances
+Author-email: zscaler-partner-labs@z-bd.com
+Requires-Python: >=3.8,<4.0
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: python-box (==7.0.0)
+Requires-Dist: restfly (==1.4.7)
+Project-URL: Bug Tracker, https://github.com/zscaler/zscaler-sdk-python/issues
+Project-URL: Documentation, https://zscaler-sdk-python.readthedocs.io/
+Project-URL: Repository, https://github.com/zscaler/zscaler-sdk-python
+Description-Content-Type: text/markdown
+
+# Zscaler SDK Python for the Zscaler API
+
+[![Build Status](https://github.com/zscaler/zscaler-sdk-python/actions/workflows/build.yml/badge.svg)](https://github.com/zscaler/zscaler-sdk-python/actions/workflows/build.yml)
+[![Documentation Status](https://readthedocs.org/projects/zscaler/badge/?version=latest)](https://zscaler.readthedocs.io/?badge=latest)
+[![License](https://img.shields.io/github/license/zscaler/zscaler-sdk-python.svg)](https://github.com/zscaler/zscaler-sdk-python)
+[![Code Quality](https://app.codacy.com/project/badge/Grade/d339fa5d957140f496fdb5c40abc4666)](https://www.codacy.com/gh/zscaler/zscaler-sdk-python/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=zscaler/zscaler-sdk-python&amp;utm_campaign=Badge_Grade)
+[![PyPI Version](https://img.shields.io/pypi/v/zscaler.svg)](https://pypi.org/project/zscaler-sdk-python)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/zscaler.svg)](https://pypi.python.org/pypi/zscaler-sdk-python/)
+[![GitHub Release](https://img.shields.io/github/release/zscaler/zscaler-sdk-python.svg)](https://github.com/zscaler/zscaler-sdk-python/releases/)
+
+Zscaler SDK Python is an SDK that provides a uniform and easy-to-use interface for each of the Zscaler product APIs.
+
+## Quick links
+* [Zscaler SDK Python API Documentation](https://zscaler-sdk-python.readthedocs.io)
+
+## Overview
+Each Zscaler product has separate developer documentation and authentication methods. This SDK simplifies
+software development using the Zscaler API.
+
+This SDK leverages the [RESTfly framework](https://restfly.readthedocs.io/en/latest/index.html) developed
+by Steve McGrath.
+
+## Features
+- Simplified authentication with Zscaler APIs.
+- Uniform interaction with all Zscaler APIs.
+- Uses [python-box](https://github.com/cdgriffith/Box/wiki) to add dot notation access to json data structures.
+- Zscaler API output automatically converted from CamelCase to Snake Case.
+- Various quality of life enhancements for object CRUD methods.
+
+## Products
+- Zscaler Private Access (ZPA)
+- Zscaler Internet Access (ZIA)
+
+## Installation
+
+The most recent version can be installed from pypi as per below.
+
+    $ pip install zscaler-sdk-python
+
+## Usage
+
+Before you can interact with any of the Zscaler APIs, you may need to generate API keys or retrieve tenancy information
+for each product that you are interfacing with. Once you have the requirements and you have installed Zscaler SDK Python, you're ready to go.
+
+### Quick ZIA Example
+
+```python
+from zscaler import ZIA
+from pprint import pprint
+
+zia = ZIA(api_key='API_KEY', cloud='CLOUD', username='USERNAME', password='PASSWORD')
+for user in zia.users.list_users():
+    pprint(user)
+```
+
+### Quick ZPA Example
+
+```python
+from zscaler import ZPA
+from pprint import pprint
+
+zpa = ZPA(client_id='CLIENT_ID', client_secret='CLIENT_SECRET', customer_id='CUSTOMER_ID')
+for app_segment in zpa.app_segments.list_segments():
+    pprint(app_segment)
+```
+
+## Documentation
+### API Documentation
+Zscaler SDK Python's API is fully 100% documented and is hosted at [ReadTheDocs](https://zscaler-sdk-python.readthedocs.io).
+
+This documentation should be used when working with Zscaler SDK Python rather than referring to Zscaler's API reference.
+Zscaler SDK Python makes some quality of life improvements to simplify and clarify arguments passed to Zscaler's API.
+
+## Is It Tested?
+Yes! Zscaler SDK Python has a complete test suite that fully covers all methods within the ZIA and ZPA modules.
+
+## Contributing
+
+Contributions to Zscaler SDK Python are absolutely welcome.
+
+Please see the [Contribution Guidelines](https://github.com/zscaler/zscaler-sdk-python/blob/main/CONTRIBUTING.md) for more information.
+
+[Poetry](https://python-poetry.org/docs/) is currently being used for builds and management. You'll want to have
+poetry installed and available in your environment.
+
+## Issues
+Please feel free to open an issue using [Github Issues](https://github.com/zscaler/zscaler-sdk-python/issues) if you run into any problems using Zscaler SDK Python.
+
+## License
+MIT License
+
+=======
+
+Copyright (c) 2023 [Zscaler](https://github.com/zscaler)
+
+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.
+

zscaler_sdk_python-1.0.0/README.md

@@ -0,0 +1,112 @@
+# Zscaler SDK Python for the Zscaler API
+
+[![Build Status](https://github.com/zscaler/zscaler-sdk-python/actions/workflows/build.yml/badge.svg)](https://github.com/zscaler/zscaler-sdk-python/actions/workflows/build.yml)
+[![Documentation Status](https://readthedocs.org/projects/zscaler/badge/?version=latest)](https://zscaler.readthedocs.io/?badge=latest)
+[![License](https://img.shields.io/github/license/zscaler/zscaler-sdk-python.svg)](https://github.com/zscaler/zscaler-sdk-python)
+[![Code Quality](https://app.codacy.com/project/badge/Grade/d339fa5d957140f496fdb5c40abc4666)](https://www.codacy.com/gh/zscaler/zscaler-sdk-python/dashboard?utm_source=github.com&utm_medium=referral&utm_content=zscaler/zscaler-sdk-python&utm_campaign=Badge_Grade)
+[![PyPI Version](https://img.shields.io/pypi/v/zscaler.svg)](https://pypi.org/project/zscaler-sdk-python)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/zscaler.svg)](https://pypi.python.org/pypi/zscaler-sdk-python/)
+[![GitHub Release](https://img.shields.io/github/release/zscaler/zscaler-sdk-python.svg)](https://github.com/zscaler/zscaler-sdk-python/releases/)
+
+Zscaler SDK Python is an SDK that provides a uniform and easy-to-use interface for each of the Zscaler product APIs.
+
+## Quick links
+* [Zscaler SDK Python API Documentation](https://zscaler-sdk-python.readthedocs.io)
+
+## Overview
+Each Zscaler product has separate developer documentation and authentication methods. This SDK simplifies
+software development using the Zscaler API.
+
+This SDK leverages the [RESTfly framework](https://restfly.readthedocs.io/en/latest/index.html) developed
+by Steve McGrath.
+
+## Features
+- Simplified authentication with Zscaler APIs.
+- Uniform interaction with all Zscaler APIs.
+- Uses [python-box](https://github.com/cdgriffith/Box/wiki) to add dot notation access to json data structures.
+- Zscaler API output automatically converted from CamelCase to Snake Case.
+- Various quality of life enhancements for object CRUD methods.
+
+## Products
+- Zscaler Private Access (ZPA)
+- Zscaler Internet Access (ZIA)
+
+## Installation
+
+The most recent version can be installed from pypi as per below.
+
+    $ pip install zscaler-sdk-python
+
+## Usage
+
+Before you can interact with any of the Zscaler APIs, you may need to generate API keys or retrieve tenancy information
+for each product that you are interfacing with. Once you have the requirements and you have installed Zscaler SDK Python, you're ready to go.
+
+### Quick ZIA Example
+
+```python
+from zscaler import ZIA
+from pprint import pprint
+
+zia = ZIA(api_key='API_KEY', cloud='CLOUD', username='USERNAME', password='PASSWORD')
+for user in zia.users.list_users():
+    pprint(user)
+```
+
+### Quick ZPA Example
+
+```python
+from zscaler import ZPA
+from pprint import pprint
+
+zpa = ZPA(client_id='CLIENT_ID', client_secret='CLIENT_SECRET', customer_id='CUSTOMER_ID')
+for app_segment in zpa.app_segments.list_segments():
+    pprint(app_segment)
+```
+
+## Documentation
+### API Documentation
+Zscaler SDK Python's API is fully 100% documented and is hosted at [ReadTheDocs](https://zscaler-sdk-python.readthedocs.io).
+
+This documentation should be used when working with Zscaler SDK Python rather than referring to Zscaler's API reference.
+Zscaler SDK Python makes some quality of life improvements to simplify and clarify arguments passed to Zscaler's API.
+
+## Is It Tested?
+Yes! Zscaler SDK Python has a complete test suite that fully covers all methods within the ZIA and ZPA modules.
+
+## Contributing
+
+Contributions to Zscaler SDK Python are absolutely welcome.
+
+Please see the [Contribution Guidelines](https://github.com/zscaler/zscaler-sdk-python/blob/main/CONTRIBUTING.md) for more information.
+
+[Poetry](https://python-poetry.org/docs/) is currently being used for builds and management. You'll want to have
+poetry installed and available in your environment.
+
+## Issues
+Please feel free to open an issue using [Github Issues](https://github.com/zscaler/zscaler-sdk-python/issues) if you run into any problems using Zscaler SDK Python.
+
+## License
+MIT License
+
+=======
+
+Copyright (c) 2023 [Zscaler](https://github.com/zscaler)
+
+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.

zscaler_sdk_python-1.0.0/pyproject.toml

@@ -0,0 +1,80 @@
+[tool.poetry]
+name = "zscaler-sdk-python"
+version = "1.0.0"
+description = "Framework for interacting with Zscaler Cloud via API"
+authors = ["Zscaler Technology Alliances <zscaler-partner-labs@z-bd.com>"]
+license = "MIT"
+keywords = ["zscaler", "zpa", "zia", "zscaler-sdk-python"]
+readme = "README.md"
+documentation = "https://zscaler-sdk-python.readthedocs.io/"
+homepage = "https://github.com/zscaler/zscaler-sdk-python"
+repository = "https://github.com/zscaler/zscaler-sdk-python"
+packages = [
+    { include = "zscaler" }
+]
+classifiers = [
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Topic :: Security",
+    "Topic :: Software Development :: Libraries :: Python Modules", ]
+include = [
+    "LICENSE",
+]
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/zscaler/zscaler-sdk-python/issues"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+restfly = "1.4.7"
+python-box = "7.0.0"
+
+[tool.poetry.dev-dependencies]
+python = "^3.8"
+restfly = "1.4.7"
+python-box = "7.0.0"
+sphinx = "6.1.3"
+pytest = "7.2.1"
+requests = "2.28.2"
+pre-commit = "3.0.4"
+responses = "0.22.0"
+toml = "0.10.2"
+bandit = "^1.6.2"
+isort = "^5.12.0"
+m2r = "^0.3.1"
+black = "^23.3.0"
+poetry2setup = "^1.1.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.black]
+line-length = 127
+
+[tool.pylint.'MESSAGES CONTROL']
+disable=[
+    "format",
+    "missing-module-docstring",
+    "missing-class-docstring",
+    "missing-function-docstring",
+    "too-many-public-methods",
+    "anomalous-backslash-in-string",
+    "import-error",
+    "redefined-outer-name",
+]
+
+[tool.pylint.'FORMAT']
+max-line-length = 127
+
+[tool.isort]
+profile = "black"

zscaler_sdk_python-1.0.0/setup.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+from setuptools import setup
+
+packages = \
+['zscaler', 'zscaler.zia', 'zscaler.zpa']
+
+package_data = \
+{'': ['*']}
+
+install_requires = \
+['python-box==7.0.0', 'restfly==1.4.7']
+
+setup_kwargs = {
+    'name': 'zscaler-sdk-python',
+    'version': '1.0.0',
+    'description': 'Framework for interacting with Zscaler Cloud via API',
+    'long_description': '# Zscaler SDK Python for the Zscaler API\n\n[![Build Status](https://github.com/zscaler/zscaler-sdk-python/actions/workflows/build.yml/badge.svg)](https://github.com/zscaler/zscaler-sdk-python/actions/workflows/build.yml)\n[![Documentation Status](https://readthedocs.org/projects/zscaler/badge/?version=latest)](https://zscaler.readthedocs.io/?badge=latest)\n[![License](https://img.shields.io/github/license/zscaler/zscaler-sdk-python.svg)](https://github.com/zscaler/zscaler-sdk-python)\n[![Code Quality](https://app.codacy.com/project/badge/Grade/d339fa5d957140f496fdb5c40abc4666)](https://www.codacy.com/gh/zscaler/zscaler-sdk-python/dashboard?utm_source=github.com&utm_medium=referral&utm_content=zscaler/zscaler-sdk-python&utm_campaign=Badge_Grade)\n[![PyPI Version](https://img.shields.io/pypi/v/zscaler.svg)](https://pypi.org/project/zscaler-sdk-python)\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/zscaler.svg)](https://pypi.python.org/pypi/zscaler-sdk-python/)\n[![GitHub Release](https://img.shields.io/github/release/zscaler/zscaler-sdk-python.svg)](https://github.com/zscaler/zscaler-sdk-python/releases/)\n\nZscaler SDK Python is an SDK that provides a uniform and easy-to-use interface for each of the Zscaler product APIs.\n\n## Quick links\n* [Zscaler SDK Python API Documentation](https://zscaler-sdk-python.readthedocs.io)\n\n## Overview\nEach Zscaler product has separate developer documentation and authentication methods. This SDK simplifies\nsoftware development using the Zscaler API.\n\nThis SDK leverages the [RESTfly framework](https://restfly.readthedocs.io/en/latest/index.html) developed\nby Steve McGrath.\n\n## Features\n- Simplified authentication with Zscaler APIs.\n- Uniform interaction with all Zscaler APIs.\n- Uses [python-box](https://github.com/cdgriffith/Box/wiki) to add dot notation access to json data structures.\n- Zscaler API output automatically converted from CamelCase to Snake Case.\n- Various quality of life enhancements for object CRUD methods.\n\n## Products\n- Zscaler Private Access (ZPA)\n- Zscaler Internet Access (ZIA)\n\n## Installation\n\nThe most recent version can be installed from pypi as per below.\n\n    $ pip install zscaler-sdk-python\n\n## Usage\n\nBefore you can interact with any of the Zscaler APIs, you may need to generate API keys or retrieve tenancy information\nfor each product that you are interfacing with. Once you have the requirements and you have installed Zscaler SDK Python, you\'re ready to go.\n\n### Quick ZIA Example\n\n```python\nfrom zscaler import ZIA\nfrom pprint import pprint\n\nzia = ZIA(api_key=\'API_KEY\', cloud=\'CLOUD\', username=\'USERNAME\', password=\'PASSWORD\')\nfor user in zia.users.list_users():\n    pprint(user)\n```\n\n### Quick ZPA Example\n\n```python\nfrom zscaler import ZPA\nfrom pprint import pprint\n\nzpa = ZPA(client_id=\'CLIENT_ID\', client_secret=\'CLIENT_SECRET\', customer_id=\'CUSTOMER_ID\')\nfor app_segment in zpa.app_segments.list_segments():\n    pprint(app_segment)\n```\n\n## Documentation\n### API Documentation\nZscaler SDK Python\'s API is fully 100% documented and is hosted at [ReadTheDocs](https://zscaler-sdk-python.readthedocs.io).\n\nThis documentation should be used when working with Zscaler SDK Python rather than referring to Zscaler\'s API reference.\nZscaler SDK Python makes some quality of life improvements to simplify and clarify arguments passed to Zscaler\'s API.\n\n## Is It Tested?\nYes! Zscaler SDK Python has a complete test suite that fully covers all methods within the ZIA and ZPA modules.\n\n## Contributing\n\nContributions to Zscaler SDK Python are absolutely welcome.\n\nPlease see the [Contribution Guidelines](https://github.com/zscaler/zscaler-sdk-python/blob/main/CONTRIBUTING.md) for more information.\n\n[Poetry](https://python-poetry.org/docs/) is currently being used for builds and management. You\'ll want to have\npoetry installed and available in your environment.\n\n## Issues\nPlease feel free to open an issue using [Github Issues](https://github.com/zscaler/zscaler-sdk-python/issues) if you run into any problems using Zscaler SDK Python.\n\n## License\nMIT License\n\n=======\n\nCopyright (c) 2023 [Zscaler](https://github.com/zscaler)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n',
+    'author': 'Zscaler Technology Alliances',
+    'author_email': 'zscaler-partner-labs@z-bd.com',
+    'maintainer': 'None',
+    'maintainer_email': 'None',
+    'url': 'https://github.com/zscaler/zscaler-sdk-python',
+    'packages': packages,
+    'package_data': package_data,
+    'install_requires': install_requires,
+    'python_requires': '>=3.8,<4.0',
+}
+
+
+setup(**setup_kwargs)

zscaler_sdk_python-1.0.0/zscaler/__init__.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2023, Zscaler Inc.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+"""Zscaler SDK for Python
+
+Zscaler SDK Python is an SDK that provides a uniform and easy-to-use interface for each of the Zscaler product APIs.
+
+Documentation available at https://zscaler-sdk-python.readthedocs.io
+
+"""
+
+__author__ = "Zscaler Inc"
+__email__ = "zscaler-partner-labs@z-bd.com"
+__license__ = "MIT"
+__contributors__ = [
+    "William Guilherme",
+]
+__version__ = "1.0.0"
+
+from zscaler.zia import ZIA  # noqa
+from zscaler.zpa import ZPA  # noqa

zscaler_sdk_python-1.0.0/zscaler/utils.py

@@ -0,0 +1,150 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2023, Zscaler Inc.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+import time
+
+from box import Box, BoxList
+from restfly import APIIterator
+
+
+def snake_to_camel(name: str):
+    """Converts Python Snake Case to Zscaler's lower camelCase."""
+    if "_" not in name:
+        return name
+    # Edge-cases where camelCase is breaking
+    edge_cases = {
+        "routable_ip": "routableIP",
+        "is_name_l10n_tag": "isNameL10nTag",
+        "name_l10n_tag": "nameL10nTag",
+        "surrogate_ip": "surrogateIP",
+        "surrogate_ip_enforced_for_known_browsers": "surrogateIPEnforcedForKnownBrowsers",
+    }
+    return edge_cases.get(name, name[0].lower() + name.title()[1:].replace("_", ""))
+
+
+def chunker(lst, n):
+    """Yield successive n-sized chunks from lst."""
+    for i in range(0, len(lst), n):
+        yield lst[i : i + n]
+
+
+# Recursive function to convert all keys and nested keys from snake case
+# to camel case.
+def convert_keys(data):
+    if isinstance(data, (list, BoxList)):
+        return [convert_keys(inner_dict) for inner_dict in data]
+    elif isinstance(data, (dict, Box)):
+        new_dict = {}
+        for k in data.keys():
+            v = data[k]
+            new_key = snake_to_camel(k)
+            new_dict[new_key] = convert_keys(v) if isinstance(v, (dict, list)) else v
+        return new_dict
+    else:
+        return data
+
+
+def keys_exists(element: dict, *keys):
+    """
+    Check if *keys (nested) exists in `element` (dict).
+    """
+    if not isinstance(element, dict):
+        raise AttributeError("keys_exists() expects dict as first argument.")
+    if not keys:
+        raise AttributeError("keys_exists() expects at least two arguments, one given.")
+
+    _element = element
+    for key in keys:
+        try:
+            _element = _element[key]
+        except KeyError:
+            return False
+    return True
+
+
+# Takes a tuple if id_groups, kwargs and the payload dict; reformat for API call
+def add_id_groups(id_groups: list, kwargs: dict, payload: dict):
+    for entry in id_groups:
+        if kwargs.get(entry[0]):
+            payload[entry[1]] = [{"id": param_id} for param_id in kwargs.pop(entry[0])]
+    return
+
+
+def obfuscate_api_key(seed: list):
+    now = int(time.time() * 1000)
+    n = str(now)[-6:]
+    r = str(int(n) >> 1).zfill(6)
+    key = "".join(seed[int(str(n)[i])] for i in range(len(str(n))))
+    for j in range(len(r)):
+        key += seed[int(r[j]) + 2]
+
+    return {"timestamp": now, "key": key}
+
+
+def pick_version_profile(kwargs: list, payload: list):
+    # Used in ZPA endpoints.
+    # This function is used to convert the name of the version profile to
+    # the version profile id. This means our users don't need to look up the
+    # version profile id mapping themselves.
+
+    version_profile = kwargs.pop("version_profile", None)
+    if version_profile:
+        payload["overrideVersionProfile"] = True
+        if version_profile == "default":
+            payload["versionProfileId"] = 0
+        elif version_profile == "previous_default":
+            payload["versionProfileId"] = 1
+        elif version_profile == "new_release":
+            payload["versionProfileId"] = 2
+
+
+class Iterator(APIIterator):
+    """Iterator class."""
+
+    page_size = 100
+
+    def __init__(self, api, path: str = "", **kw):
+        """Initialize Iterator class."""
+        super().__init__(api, **kw)
+
+        self.path = path
+        self.max_items = kw.pop("max_items", 0)
+        self.max_pages = kw.pop("max_pages", 0)
+        self.payload = {}
+        if kw:
+            self.payload = {snake_to_camel(key): value for key, value in kw.items()}
+
+    def _get_page(self) -> None:
+        """Iterator function to get the page."""
+        resp = self._api.get(
+            self.path,
+            params={**self.payload, "page": self.num_pages + 1},
+        )
+        try:
+            # If we are using ZPA then the API will return records under the
+            # 'list' key.
+            self.page = resp.get("list") or []
+        except AttributeError:
+            # If the list key doesn't exist then we're likely using ZIA so just
+            # return the full response.
+            self.page = resp
+        finally:
+            # If we use the default retry-after logic in Restfly then we are
+            # going to keep seeing 429 messages in stdout. ZIA and ZPA have a
+            # standard 1 sec rate limit on the API endpoints with pagination so
+            # we are going to include it here.
+            time.sleep(1)