Customers

class effipy.customers.Customers(parent, object_id=None)

Bases: effipy.resource.EffiPeopleResource

Customers management

Use object_id to get the endpoint to a escpecific customer.

create(dict)

Create a new customer withi a dict that will be converted to JSON.

Parameters:dict (dict) – A dictionary with customer data like the following:

 {
  "id": "Identificador unico cliente",
  "fiscalId": "CIF, NIF, Pasaporte",
  "firstName": "Nombre",
  "firstSurname": "Primer apellido",
  "secondSurname": "Segundo apellido",
  "email": "correo@cliente.com",
  "address": {
      "street": "Calle y número",
      "postalCode": "CodigoPostal",
      "city": "Nombre ciudad",
      "cityCode": "Código INE ciudad",
      "province": "Nombre provincia",
      "provinceCode": "Código INE provincia",
      "country": "España",
      "countryCode": "Codigo",
      "parcelNumber": "Referencia catastral"
   }
}

add_filter(filter_function)

apply_filters(request)

contract(object_id)

contracts()

delete(*args, **kwargs)

Delete this resource.

filters = ()

get(*args, **kwargs)

get()

`get()` method for all the EffiPeople resources.

Parameters:

• start (int) – Start of the results
• limit (int) – Limit of the results

get_url()

Get the URL for the endpoint.

In our case, we replace ‘/’ for ‘-‘ for the object identifier.

list_methods()

list_resources()

parent = None

path = 'customers'

require(condition)

require_collection()

require_item()

update(*args, **kwargs)

wrap_object(obj)