SDK для TypeScript
Пакет @requiply/api-sdk експортує RequiplyClient, RequiplyError, а також усі публічні типи TypeScript зі своєї кореневої точки входу.
Початок роботи
Ресурси
- Інвентар і категорії, зокрема комплекти
- Доступність і ціни
- Бронювання
- Клієнти
- Продажі та товари на продаж
- Організація
- Звіти
Усі запити надсилаються за адресою:
https://api.requiply.com/api/public/v1
Оновлення зі старіших версій
Версія 0.2.0 узгоджує SDK з публічним API. Ці зміни можуть зламати код, написаний для 0.1.x:
| Зміна | Що робити |
|---|---|
RequiplyError.code прибрано. Його ніколи не заповнювали. | Читайте error.reason, щоб отримати машиночитну причину, а error.data, щоб отримати повʼязані з нею поля. Див. Обробка помилок. |
Параметр запиту idempotencyKey прибрано. API ніколи не усував дублікати запитів. | Не повторюйте bookings.create() чи sales.create() наосліп: повтор може створити друге бронювання чи продаж. Див. Параметри запитів. |
bookings.create() повертає або створене бронювання, або відхилене. | Перевіряйте result.success, перш ніж читати reservationId. Див. Бронювання. |
paymentType обовʼязковий, якщо asRequest не дорівнює true. | Передавайте paymentType для звичайних бронювань. API і раніше відхиляв їх без нього. |
Версія 0.2.0 також додає: ресурси Продажі; saleLines і adjustment у розрахунках ціни та бронюваннях; workingHours в org.info(); saleItems у деталях бронювання; excludeFromDiscounts у послугах; stillOutUnits у записах звіту про прострочення. Повний перелік наведено в CHANGELOG пакета.
Версія 0.2.1 додає комплекти: bundles.list() і bundles.get(); bundles у pricing.quote() і bookings.create(); bundleDiscountAmount і lineBundles у розрахунках ціни; bundles у деталях групи товарів. Нічого не ламається.