{ "info": { "author": "VX FIBER", "author_email": "info@vx.se", "bugtrack_url": null, "classifiers": [ "Development Status :: 1 - Planning", "Intended Audience :: System Administrators", "Intended Audience :: Telecommunications Industry", "License :: OSI Approved :: Apache Software License", "Operating System :: POSIX :: Linux", "Programming Language :: Python", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "# Vxapi Client\nThe Vxfiber API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\nThis Python library provides convenient access to the Vxfiber API from applications written in the Python language. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses which makes it compatible with a wide range of versions of the vxfiber API.\n\n## Examples\n\n#### Client initialization\nGive url and path for swagger's cache (it automatically call spec endpoint to known all specification's endpoints)\n> client = Client(url='https://vxapitest-test-test.vx.se', cache_path='/tmp/pyvxclient.swagger.json')\n> token = client.get_token('massimo', 'password')\n> client.api_key = token['api_key']\n> client.setup()\n\nAlert: cache_path must end with .json extension\n\n#### Actions\n\n- get customers with limit results\n> client.Customer.get(limit=5)\n>\n> idc = ret.json['data'][0]['id']\n\n- get just customers on first page\n> client.Customer.get(page=1, per_page=20)\n- get customers filtered and ordered\n> client.Customer.get(limit=5, q=[\"country_code:it\",\"city:Milan\"], sort=\"-created\")\n\n- get single customer\n> client.Customer.get(limit=5, q=[\"id:D28E299D-8673-41AB-89B4-1B20F64F8E02\"])\n\n- get single customer, with only some fields\n> client.Customers.get(limit=5, q=[\"id:D28E299D-8673-41AB-89B4-1B20F64F8E02\"], fields=['id', 'first_name', 'last_name'])\n\n- create customer\n> ret = client.Customer.create(first_name='pluto',\n last_name='pluto',\n password='ciao#1234',\n email='ciao@test.it',\n province='',\n city='',\n customer_type='Residential',\n postal_code='',\n language='English',\n mobile_number='',\n phone_number='',\n street_address='')\n>\n> idc = ret.json['data']['id']\n\n- modify customer\n> client.Customer.update(id=idc, first_name='pluto2')\n\nThere are many others resources (partially or full implemented):\n\n- client.ApiUser\n- client.Inventory\n- client.NetworkOperator\n- client.Network\n- client.ObjectGroup\n- client.Object\n- client.Order\n- client.Customer\n- client.Service\n...\n\nAll results are returned inside an instance of ApiResponse. The same object is used when there are no results (404).\nFor every methods (get, create, update, delete) of a resource could generate many types of errors: BadRequest(400), Forbidden(403), Unauthorized(401), ServerError(5xx), ClientError(others).", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://www.vx.se", "keywords": "", "license": "Copyright VNEXT AB", "maintainer": "", "maintainer_email": "", "name": "pyvxclient", "package_url": "https://pypi.org/project/pyvxclient/", "platform": "", "project_url": "https://pypi.org/project/pyvxclient/", "project_urls": { "Homepage": "http://www.vx.se" }, "release_url": "https://pypi.org/project/pyvxclient/0.2.6/", "requires_dist": null, "requires_python": ">=3.6", "summary": "vxapi client", "version": "0.2.6", "yanked": false, "yanked_reason": null }, "last_serial": 6793733, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "d1de6de83278022293218f2ef38032bc", "sha256": "765e37bfe6e3708e00a26432cbf374552f8fa4690ce638b69bceafdeb91b74f6" }, "downloads": -1, "filename": "pyvxclient-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "d1de6de83278022293218f2ef38032bc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7", "size": 38913, "upload_time": "2019-06-05T13:48:27", "upload_time_iso_8601": "2019-06-05T13:48:27.914483Z", "url": "https://files.pythonhosted.org/packages/21/7c/39ce4a2500618ec4d66d99557275c1d2158d49ec6cdabcd1cdcfaff7851b/pyvxclient-0.0.1-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "2836450d550a98b066317f63810ce74a", "sha256": "4906018571727fc5a849493783b0462072049b5126f1acc26a80cc124d0eb261" }, "downloads": -1, "filename": "pyvxclient-0.0.1.tar.gz", "has_sig": false, "md5_digest": "2836450d550a98b066317f63810ce74a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 32533, "upload_time": "2019-06-05T13:48:30", "upload_time_iso_8601": "2019-06-05T13:48:30.317432Z", "url": "https://files.pythonhosted.org/packages/3c/11/8ca38c5b14ca91bfa83537b5631fae91e2e38fc13833d594410c09ec3ca4/pyvxclient-0.0.1.tar.gz", "yanked": false, "yanked_reason": null } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "642c0d4b525485295e4ecd496079bade", "sha256": "1244eb36fd7af7daa601fae91a5b2a6146620341ed45aa0b84f5e90ee9351e54" }, "downloads": -1, "filename": "pyvxclient-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "642c0d4b525485295e4ecd496079bade", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7", "size": 36239, "upload_time": "2019-06-14T13:21:16", "upload_time_iso_8601": "2019-06-14T13:21:16.374524Z", "url": "https://files.pythonhosted.org/packages/d8/a3/cda8912f163c94dcbaf1f6c15e4f71baf242a866b0fe647d007e82fd92d4/pyvxclient-0.1.2-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "a2ca210967471bb614ba1c7de9663447", "sha256": "17393c68f6c36beea633b1f3b66cfdb285f34f5ba463fc1d8cc3643d8ba7892b" }, "downloads": -1, "filename": "pyvxclient-0.1.2.tar.gz", "has_sig": false, "md5_digest": "a2ca210967471bb614ba1c7de9663447", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 31326, "upload_time": "2019-06-14T13:21:17", "upload_time_iso_8601": "2019-06-14T13:21:17.909117Z", "url": "https://files.pythonhosted.org/packages/68/69/50c5e60da9606e69fa47244bcd57611acd209f26775c6e3847e4dd8101a6/pyvxclient-0.1.2.tar.gz", "yanked": false, "yanked_reason": null } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "e4be5c8deb19bf9690064457b27127b7", "sha256": "891af02a9cf43c46d3d622d4a91a6bb6bafae84e3328008f625dfe71d0fc4433" }, "downloads": -1, "filename": "pyvxclient-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "e4be5c8deb19bf9690064457b27127b7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 35870, "upload_time": "2019-06-17T12:31:13", "upload_time_iso_8601": "2019-06-17T12:31:13.490783Z", "url": "https://files.pythonhosted.org/packages/a5/1f/4f1a42c6e71e8d0947bce0c3217c7581d2a7471f4f8ae8a1e2df12a2466a/pyvxclient-0.1.3-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "ccc80343a46840110e08a45cb2c4e99b", "sha256": "92a4f2a0f19134af2245247f73ebe4e259fb9491616b80f88d805edbc69281d0" }, "downloads": -1, "filename": "pyvxclient-0.1.3.tar.gz", "has_sig": false, "md5_digest": "ccc80343a46840110e08a45cb2c4e99b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 31402, "upload_time": "2019-06-17T12:31:16", "upload_time_iso_8601": "2019-06-17T12:31:16.432704Z", "url": "https://files.pythonhosted.org/packages/b4/d0/6cfa5819d97999cbd8c047791056b4c0e0db9099350e716df84f8d82d9c2/pyvxclient-0.1.3.tar.gz", "yanked": false, "yanked_reason": null } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "02c9d2c2319dd22fd6fd1dcda26381e8", "sha256": "9a44f4e008f183a00ca990d5b4033ba6ccc5aa64c382efc23a96720556fd1b31" }, "downloads": -1, "filename": "pyvxclient-0.1.4.tar.gz", "has_sig": false, "md5_digest": "02c9d2c2319dd22fd6fd1dcda26381e8", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 31489, "upload_time": "2019-10-09T14:19:23", "upload_time_iso_8601": "2019-10-09T14:19:23.378655Z", "url": "https://files.pythonhosted.org/packages/c0/01/04d39d1916f59d96245946b31e5c50e0ed520075093f7d3229efea74a377/pyvxclient-0.1.4.tar.gz", "yanked": false, "yanked_reason": null } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "3de8837484f0ccc4e3f05848f339211c", "sha256": "124e76785ae48f6b7784d20a311c011ae78db732a3c45a53f0b501b0966c8ec3" }, "downloads": -1, "filename": "pyvxclient-0.2.0.tar.gz", "has_sig": false, "md5_digest": "3de8837484f0ccc4e3f05848f339211c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 32588, "upload_time": "2019-10-24T14:05:13", "upload_time_iso_8601": "2019-10-24T14:05:13.265807Z", "url": "https://files.pythonhosted.org/packages/92/fe/43118e108912d853764466f79377aff97793c37dad09f35a00d8de4e280b/pyvxclient-0.2.0.tar.gz", "yanked": false, "yanked_reason": null } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "df9048434681d0e85f3ca377c9f8fc1f", "sha256": "0eee80fb12384247b54ed8fa31b307a1a94c181182e6f27a9fac3c6e395d3ee3" }, "downloads": -1, "filename": "pyvxclient-0.2.1.tar.gz", "has_sig": false, "md5_digest": "df9048434681d0e85f3ca377c9f8fc1f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 32737, "upload_time": "2019-10-24T15:29:53", "upload_time_iso_8601": "2019-10-24T15:29:53.170391Z", "url": "https://files.pythonhosted.org/packages/91/79/549745405beb577a133a4bd25301db7c4ff312f4d0bbd1bb83d5307f8d8b/pyvxclient-0.2.1.tar.gz", "yanked": false, "yanked_reason": null } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "e6810b371d0ed14b3c37d5e39c6ffdad", "sha256": "2623220c4d0b75cd78acce30ec5791d21c8b37bbcd6b8ad21cfaa591e75481d3" }, "downloads": -1, "filename": "pyvxclient-0.2.2.tar.gz", "has_sig": false, "md5_digest": "e6810b371d0ed14b3c37d5e39c6ffdad", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 32734, "upload_time": "2019-10-30T10:41:16", "upload_time_iso_8601": "2019-10-30T10:41:16.189101Z", "url": "https://files.pythonhosted.org/packages/23/7b/bbc8ed5471d2c31351efd411ca07fa6b10af6cd8eeaf6bb7834e5479634a/pyvxclient-0.2.2.tar.gz", "yanked": false, "yanked_reason": null } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "f53934f78585411022a9419b17d044e5", "sha256": "47bd5844038774dd40881a48b366a09385174f07bf41592834969cb3bd5d1efb" }, "downloads": -1, "filename": "pyvxclient-0.2.3.tar.gz", "has_sig": false, "md5_digest": "f53934f78585411022a9419b17d044e5", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 34152, "upload_time": "2019-10-30T11:03:34", "upload_time_iso_8601": "2019-10-30T11:03:34.501418Z", "url": "https://files.pythonhosted.org/packages/1d/ba/ce7e5c54e3492a2ff9d0a75eb642dd3f68b195ec308416c3633375cf188a/pyvxclient-0.2.3.tar.gz", "yanked": false, "yanked_reason": null } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "84757975e91dad7588daf19073c1f66b", "sha256": "28f63b3e009f57ca69944cf57c67ec5901c63b75852a5fc579f1ae1550fdd9b7" }, "downloads": -1, "filename": "pyvxclient-0.2.4.tar.gz", "has_sig": false, "md5_digest": "84757975e91dad7588daf19073c1f66b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 34598, "upload_time": "2020-03-11T15:31:22", "upload_time_iso_8601": "2020-03-11T15:31:22.930013Z", "url": "https://files.pythonhosted.org/packages/41/22/ba9dc837577ba57a4bc13ff0c761c0ab7f3e9b7f62593079b3fe9285f64c/pyvxclient-0.2.4.tar.gz", "yanked": false, "yanked_reason": null } ], "0.2.5": [ { "comment_text": "", "digests": { "md5": "a3a0d28b3351fdaa0d7f83549438caeb", "sha256": "22277396049c62933e021d3f633482848699d4642ce8bfaa1c5d1b2fdddc018d" }, "downloads": -1, "filename": "pyvxclient-0.2.5.tar.gz", "has_sig": false, "md5_digest": "a3a0d28b3351fdaa0d7f83549438caeb", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 34593, "upload_time": "2020-03-11T15:42:26", "upload_time_iso_8601": "2020-03-11T15:42:26.354991Z", "url": "https://files.pythonhosted.org/packages/66/43/5c1336691dbf26a381d2b101f8fc19d2edac1352f7ab383a8ac2162c395e/pyvxclient-0.2.5.tar.gz", "yanked": false, "yanked_reason": null } ], "0.2.6": [ { "comment_text": "", "digests": { "md5": "f0b21c993910d18ea08ac32909207a42", "sha256": "ca4b0cd43ea9c2c4e82b34d5b9b0a421fd2f96a53f2fbb00ac2d94757073514f" }, "downloads": -1, "filename": "pyvxclient-0.2.6.tar.gz", "has_sig": false, "md5_digest": "f0b21c993910d18ea08ac32909207a42", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 34594, "upload_time": "2020-03-11T17:03:08", "upload_time_iso_8601": "2020-03-11T17:03:08.236745Z", "url": "https://files.pythonhosted.org/packages/0b/67/4dcb2701cc9c7173ce2864ba0f880d686e122e3c9ab8113a71f593c100e8/pyvxclient-0.2.6.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f0b21c993910d18ea08ac32909207a42", "sha256": "ca4b0cd43ea9c2c4e82b34d5b9b0a421fd2f96a53f2fbb00ac2d94757073514f" }, "downloads": -1, "filename": "pyvxclient-0.2.6.tar.gz", "has_sig": false, "md5_digest": "f0b21c993910d18ea08ac32909207a42", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 34594, "upload_time": "2020-03-11T17:03:08", "upload_time_iso_8601": "2020-03-11T17:03:08.236745Z", "url": "https://files.pythonhosted.org/packages/0b/67/4dcb2701cc9c7173ce2864ba0f880d686e122e3c9ab8113a71f593c100e8/pyvxclient-0.2.6.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }