SDK TypeScript
Pakiet @requiply/api-sdk eksportuje RequiplyClient, RequiplyError i wszystkie publiczne typy TypeScript z głównego punktu wejścia.
Pierwsze kroki
Zasoby
- Sprzęt i kategorie, w tym zestawy
- Dostępność i ceny
- Rezerwacje
- Klienci
- Sprzedaż i towary na sprzedaż
- Organizacja
- Raporty
Wszystkie żądania są wysyłane pod adres:
https://api.requiply.com/api/public/v1
Aktualizacja ze starszych wersji
Wersja 0.2.0 dostosowuje SDK do publicznego API. Te zmiany mogą zepsuć kod napisany dla wersji 0.1.x:
| Zmiana | Co zrobić |
|---|---|
Usunięto RequiplyError.code. Nigdy nie było ustawiane. | Odczytuj error.reason, aby poznać przyczynę w formie czytelnej dla programu, i error.data, aby poznać towarzyszące jej pola. Zobacz Obsługa błędów. |
Usunięto opcję żądania idempotencyKey. API nigdy nie usuwało duplikatów żądań. | Nie ponawiaj bookings.create() ani sales.create() na ślepo: ponowienie może utworzyć drugą rezerwację lub sprzedaż. Zobacz Opcje żądań. |
bookings.create() zwraca albo utworzoną rezerwację, albo odrzuconą. | Sprawdź result.success, zanim odczytasz reservationId. Zobacz Rezerwacje. |
paymentType jest wymagane, chyba że asRequest ma wartość true. | Przekazuj paymentType w zwykłych rezerwacjach. API już wcześniej je bez niego odrzucało. |
Wersja 0.2.0 dodaje też zasoby Sprzedaż, saleLines i adjustment w wycenach i rezerwacjach, workingHours w org.info(), saleItems w szczegółach rezerwacji, excludeFromDiscounts w usługach i stillOutUnits we wpisach raportu zwrotów po terminie. Pełną listę zawiera CHANGELOG pakietu.
Wersja 0.2.1 dodaje zestawy: bundles.list() i bundles.get(), bundles w pricing.quote() i bookings.create(), bundleDiscountAmount i lineBundles w wycenach oraz bundles w szczegółach grupy pozycji. Nic się nie psuje.