Клієнти
Ресурси клієнтів містять дані клієнтів і потребують секретного ключа в довіреному серверному коді.
clients.lookup()
clients.lookup(
input: ClientLookupInput,
options?: RequiplyRequestOptions,
): Promise<ClientLookupResponse>
Передайте email, phone або search; потрібен щонайменше один параметр. Метод працює у двох режимах:
| Вхідні дані | Режим | Відповідь |
|---|---|---|
email та/або phone | Точний збіг з урахуванням регістру. Якщо передано обидва, клієнт має мати обидва. | client є клієнтом, що збігся, або null. |
search | Нечіткий пошук за імʼям, прізвищем, email і телефоном. | client дорівнює null; matches перелічує до 10 клієнтів. |
const { client } = await requiply.clients.lookup({ email: 'customer@example.com' });
const { matches } = await requiply.clients.lookup({ search: 'Olena Koval' });
search розбиває текст на слова (до чотирьох). Клієнт збігається, коли кожне слово трапляється десь у його імені, прізвищі, email чи телефоні. Українські імена також шукаються в іншому алфавіті, тож Olena знаходить Олена, а Галина знаходить Halyna.
Кожен клієнт має поля id, name, lastName, email, phone, discountPercentage (0 без знижки). Імʼя, прізвище, email і телефон можуть бути null.
clients.create()
clients.create(
input: ClientCreateInput,
options?: RequiplyRequestOptions,
): Promise<ClientCreateResponse>
Вхідні дані приймають необовʼязкові поля name, lastName, email, phone. Потрібне щонайменше одне з полів email або phone.
const { client, created } = await requiply.clients.create({
name: 'Alex',
lastName: 'Morgan',
email: 'alex@example.com',
phone: '+380951234567',
});
phone має бути в міжнародному форматі E.164: на початку +, потім код країни, загалом від 7 до 15 цифр, наприклад +380951234567. Номер у національному форматі відхиляється з 400 і повідомленням "Phone must be in international E.164 format with a country code, e.g. +380951234567". Те саме правило діє у формах клієнта в застосунку та для AI-асистентів, які створюють клієнтів.Відповідь повертає клієнта та created. clients.create() захищений від дублікатів: якщо клієнт із таким email (або, якщо email немає, з таким телефоном) уже існує, ви отримаєте цього клієнта з created: false замість другого запису.