pyvxclient 0.2.6

Description:

pyvxclient 0.2.6

Vxapi Client
The 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.
This 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.
Examples
Client initialization
Give url and path for swagger's cache (it automatically call spec endpoint to known all specification's endpoints)

client = Client(url='https://vxapitest-test-test.vx.se', cache_path='/tmp/pyvxclient.swagger.json')
token = client.get_token('massimo', 'password')
client.api_key = token['api_key']
client.setup()

Alert: cache_path must end with .json extension
Actions

get customers with limit results


client.Customer.get(limit=5)
idc = ret.json['data'][0]['id']


get just customers on first page


client.Customer.get(page=1, per_page=20)


get customers filtered and ordered


client.Customer.get(limit=5, q=["country_code:it","city:Milan"], sort="-created")


get single customer


client.Customer.get(limit=5, q=["id:D28E299D-8673-41AB-89B4-1B20F64F8E02"])


get single customer, with only some fields


client.Customers.get(limit=5, q=["id:D28E299D-8673-41AB-89B4-1B20F64F8E02"], fields=['id', 'first_name', 'last_name'])


create customer


ret = client.Customer.create(first_name='pluto',
last_name='pluto',
password='ciao#1234',
email='[email protected]',
province='',
city='',
customer_type='Residential',
postal_code='',
language='English',
mobile_number='',
phone_number='',
street_address='')
idc = ret.json['data']['id']


modify customer


client.Customer.update(id=idc, first_name='pluto2')

There are many others resources (partially or full implemented):

client.ApiUser
client.Inventory
client.NetworkOperator
client.Network
client.ObjectGroup
client.Object
client.Order
client.Customer
client.Service
...

All results are returned inside an instance of ApiResponse. The same object is used when there are no results (404).
For 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).