SDK de TypeScript
El paquete @requiply/api-sdk exporta RequiplyClient, RequiplyError y todos los tipos públicos de TypeScript desde su punto de entrada raíz.
Primeros pasos
Recursos
- Inventario y categorías, packs incluidos
- Disponibilidad y precios
- Reservas
- Clientes
- Ventas y productos en venta
- Organización
- Informes
Todas las peticiones se envían bajo:
https://api.requiply.com/api/public/v1
Actualizar desde versiones anteriores
La versión 0.2.0 alinea el SDK con la API pública. Estos cambios pueden romper el código escrito para 0.1.x:
| Cambio | Qué hacer |
|---|---|
Se elimina RequiplyError.code. Nunca llegó a tener valor. | Lee error.reason para el motivo legible por máquina y error.data para los campos que lo acompañan. Consulta Gestión de errores. |
Se elimina la opción de petición idempotencyKey. La API nunca deduplicó las peticiones. | No reintentes bookings.create() ni sales.create() a ciegas: un reintento puede crear una segunda reserva o una segunda venta. Consulta Opciones de petición. |
bookings.create() devuelve una reserva creada o una reserva rechazada. | Comprueba result.success antes de leer reservationId. Consulta Reservas. |
paymentType es obligatorio salvo que asRequest sea true. | Pasa un paymentType en las reservas normales. La API ya las rechazaba sin él. |
La versión 0.2.0 también añade los recursos de Ventas, saleLines y adjustment en los presupuestos y las reservas, workingHours en org.info(), saleItems en los detalles de la reserva, excludeFromDiscounts en los servicios y stillOutUnits en las entradas del informe de reservas con retraso. La lista completa está en el CHANGELOG del paquete.
La versión 0.2.1 añade los packs: bundles.list() y bundles.get(), bundles en pricing.quote() y bookings.create(), bundleDiscountAmount y lineBundles en los presupuestos, y bundles en los detalles del grupo de artículos. No rompe nada.