KapsoEx.Platform.Customers (kapso_ex v0.1.0)

Customers are the businesses you onboard to WhatsApp. See Onboard customers.

Summary

result()

Creates a customer. Attributes: name (required), external_customer_id.

Deletes a customer.

Gets a customer.

Lists customers, most recent first.

Updates a customer's name or external_customer_id.

@type result() :: {:ok, map() | nil} | {:error, KapsoEx.Error.t()}

@spec create(KapsoEx.Client.t(), map() | keyword()) :: result()

Creates a customer. Attributes: name (required), external_customer_id.

Customers.create(client, name: "Acme", external_customer_id: "acme-1")

@spec delete(KapsoEx.Client.t(), String.t()) :: result()

Deletes a customer.

@spec get(KapsoEx.Client.t(), String.t()) :: result()

Gets a customer.

@spec list(KapsoEx.Client.t(), map() | keyword()) :: result()

Lists customers, most recent first.

Params: name_contains, external_customer_id, created_after, created_before, page, per_page.

@spec update(KapsoEx.Client.t(), String.t(), map() | keyword()) :: result()

Updates a customer's name or external_customer_id.