CustomersAPI¶
hmwrapper.customers.CustomersAPI
¶
Interface to Hallmaster customer endpoints.
block_customer(customer_id)
¶
Block a customer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
customer_id
|
str
|
Customer GUID to block. |
required |
get_all_customers()
¶
Get all customers (no hall filter).
get_customer_details()
¶
Get customer detail for the current hall context.
get_customer_notes(customer_id)
¶
Get notes for a specific customer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
customer_id
|
str
|
Customer GUID. |
required |
get_existing_addresses(customer_id)
¶
Get saved addresses for a customer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
customer_id
|
str
|
Customer GUID. |
required |
get_groups()
¶
Get customer groups.
get_new_count()
¶
Get count of new customers.
get_unverified_count()
¶
Get count of unverified users.
list_customers(include_deleted=False, only_new=False)
¶
Get all customers for the hall.