Customers

class py_veeqo.endpoints.customers.Customers(api_key: str | None = None)

Bases: PyVeeqo

This class implements all the customers api calls.

create_new_customer(data: Dict = None, json: Dict[str, Any] | List[Any] | str | int | float | bool | None = None) → Result

Create a new customer. https://developers.veeqo.com/docs#/reference/customers/customer-collection/create-a-customer

Parameters:

data (Dict, optional) – customer data. Defaults to None.
json (Optional[JSONType], optional) – customer data in json format. Defaults to None.

get_all_customers(page_size: int = 12, page: int = 1, query: str = None) → Result

Get a list of all customers. https://developers.veeqo.com/docs#/reference/customers/customer-collection/list-all-customers

Parameters:

page_size (int, optional) – Number of items per page. Defaults to 12.
page (int, optional) – Page number. Defaults to 1.
query (str, optional) – Search query. Defaults to None

update_customer_detail(customer_id: int, data: Dict = None) → Result

Update details of a specific customer. https://developers.veeqo.com/docs#/reference/customers/customer/update-customer-detail

Parameters:

customer_id (int) – customer id.
data (Dict, optional) – customer data. Defaults to None.

view_customer_detail(customer_id: int) → Result

Get details of a specific customer. https://developers.veeqo.com/docs#/reference/customers/customer/view-customer-detail

Parameters:: customer_id (int) – customer id.