Customers reference

CustomerClient

Bases: BaseClient

Source code in abacatepay/customers/client.py

class CustomerClient(BaseClient):
    def create(self, customer: Optional[CustomerMetadata | dict] = None, **kwargs) -> Customer:
        """creates a new customer using an or named arguments

        Args:
            customer (Optional[CustomerMetadata  |  dict], optional): You customer data, it can be \
            a dict, an instance of `abacatepay.customers.CustomerMetadata`.

        Returns:
            Customer: An instance of the new customer.
        """
        logger.debug(f"Creating customer with URL: {BASE_URL}/customer/create")

        json_data = prepare_data(customer or kwargs, CustomerMetadata)
        response = self._request(
            f"{BASE_URL}/customer/create",
            method="POST",
            json=json_data,
        )
        return Customer(**response.json()["data"])

    def list(self) -> list[Customer]:
        logger.debug(f"Listing customers with URL: {BASE_URL}/customer/list")
        response = self._request(f"{BASE_URL}/customer/list", method="GET")
        return [Customer(**bill) for bill in response.json()["data"]]

create(customer=None, **kwargs)

creates a new customer using an or named arguments

Parameters:

Name	Type	Description	Default
customer	Optional[CustomerMetadata | dict]	You customer data, it can be a dict, an instance of abacatepay.customers.CustomerMetadata.	None

Returns:

Name	Type	Description
Customer	Customer	An instance of the new customer.

Source code in abacatepay/customers/client.py

def create(self, customer: Optional[CustomerMetadata | dict] = None, **kwargs) -> Customer:
    """creates a new customer using an or named arguments

    Args:
        customer (Optional[CustomerMetadata  |  dict], optional): You customer data, it can be \
        a dict, an instance of `abacatepay.customers.CustomerMetadata`.

    Returns:
        Customer: An instance of the new customer.
    """
    logger.debug(f"Creating customer with URL: {BASE_URL}/customer/create")

    json_data = prepare_data(customer or kwargs, CustomerMetadata)
    response = self._request(
        f"{BASE_URL}/customer/create",
        method="POST",
        json=json_data,
    )
    return Customer(**response.json()["data"])

Customer

Bases: CustomerInline

Customer returned by API.

Parameters:

Name	Type	Description	Default
id	CustomerID	the customer unique ID in abacatepay.	required
email	str	the customer's email	required
name	str	the customer's name	required
cellphone	str	the customer's phone number	required

Source code in abacatepay/customers/models.py

class Customer(CustomerInline):
    """
    Customer returned by API.

    Args:
        id (CustomerID): the customer unique ID in abacatepay.
        tax_id (str) the customer identification (CPF or CNPJ).
        email (str): the customer's email
        name (str): the customer's name
        cellphone (str): the customer's phone number
    """
    id: CustomerID

    @property
    def tax_id(self) -> str:
        """the customer identification (CPF or CNPJ)."""
        return self.metadata.tax_id

    @property
    def name(self) -> str:
        """the customer's name"""
        return self.metadata.name

    @property
    def email(self) -> str:
        """the customer's email"""
        return self.metadata.email

    @property
    def cellphone(self) -> str:
        """the customer's phone number"""
        return self.metadata.cellphone

cellphone property

the customer's phone number

email property

the customer's email

name property

the customer's name

tax_id property

the customer identification (CPF or CNPJ).

CustomerInline

Bases: BaseModel

The customer model attached to other models

Parameters:

Name	Type	Description	Default
metadata	Customer	the metadata of the customer.	required

Source code in abacatepay/customers/models.py

class CustomerInline(BaseModel):
    """The customer model attached to other models

    Args:
        metadata (Customer): the metadata of the customer.
    """
    metadata: CustomerMetadata

CustomerMetadata

Bases: BaseModel

Customer model

Parameters:

Name	Type	Description	Default
tax_id	str	the customer identifier such as CPF or CNPJ.	required
name	str	the customer name	required
email	str	the customer email address	required
cellphone		(str): the customer phone number.	required

Source code in abacatepay/customers/models.py

class CustomerMetadata(BaseModel):
    """Customer model

    Args:
        tax_id (str):  the customer identifier such as CPF or CNPJ.
        name (str): the customer name
        email (str): the customer email address
        cellphone: (str): the customer phone number.
    """
    tax_id: str = Field(
        serialization_alias='taxId',
        validation_alias=AliasChoices('taxId', 'tax_id'),
    )
    name: str
    email: str
    cellphone: str