EffiPeople service

class effipy.service.EffiPeople(token, version='v1', test=False)

Bases: libsaas.services.base.Resource

EffiPeople Service API.

add_filter(filter_function)

apply_filters(request)

customer(customer_id)

Specific Customer in effipy.customers.Customers.

>>> from effipy import EffiPeople
>>> ef = EffiPeople(token='XXXXX')

Customers

>>> ef.customer(1234).get_url()
'https://api.effipeople.com/v1/customers/1234'

Contracts

>>> ef.customer(1234).contracts().get_url()
'https://api.effipeople.com/v1/customers/1234/contracts'
>>> ef.customer(1234).contract(1).get_url()
'https://api.effipeople.com/v1/customers/1234/contracts/1'
>>> ef.customer(1234).contract(1).versions().get_url()
'https://api.effipeople.com/v1/customers/1234/contracts/1/versions'
>>> ef.customer(1234).contract(1).version(1).get_url()
'https://api.effipeople.com/v1/customers/1234/contracts/1/versions/1'

Invoices

>>> ef.customer(1234).contract(1).invoices().get_url()
'https://api.effipeople.com/v1/customers/1234/contracts/1/invoices'
>>> ef.customer(1234).contract(1).invoice(1).get_url()
'https://api.effipeople.com/v1/customers/1234/contracts/1/invoices/1'

customers()

Endpoint to Customers in effipy.customers.Customers.

>>> from effipy import EffiPeople
>>> ef = EffiPeople(token='XXXXX')
>>> ef.customers().get_url()
'https://api.effipeople.com/v1/customers'

efficiency_reports()

filters = ()

get_url()

list_methods()

list_resources()

measure(measure_id)

measures()

parent = None

require(condition)

tariff(tariff_id)

Endpoint to Tariff effipy.tariffs.Tariffs.

>>> from effipy import EffiPeople
>>> ef = EffiPeople(token='XXXXX')
>>> ef.tariff('T1').get_url()
'https://api.effipeople.com/v1/tariffs/T1'
>>> ef.tariff('T1').versions().get_url()
'https://api.effipeople.com/v1/tariffs/T1/versions'
>>> ef.tariff('T1').version('V1').get_url()
'https://api.effipeople.com/v1/tariffs/T1/versions/V1'

tariffs()

usagepoint(point_id)

Endpoint to specific UsagePoint effipy.usagepoints.Usagepoints.

>>> from effipy import EffiPeople
>>> ef = EffiPeople(token='XXXXX')
>>> ef.usagepoint('ES00001111').get_url()
'https://api.effipeople.com/v1/usagepoints/ES00001111'

usagepoints()

Endpoint to UsagePoints.

>>> from effipy import EffiPeople
>>> ef = EffiPeople(token='XXXXX')
>>> ef.usagepoints().get_url()
'https://api.effipeople.com/v1/usagepoints'

use_json(request)