@kohost/api-client 3.0.0-beta.11 → 3.0.0-beta.12

package/README.md

@@ -0,0 +1,71 @@
+[![npm version](https://badge.fury.io/js/@kohost%2Fapi-client.svg)](https://badge.fury.io/js/@kohost%2Fapi-client)
+
+# Kohost API Client
+
+Kohost API Client is a Node.js and Browser library for interacting with the Kohost API. It provides a simple and convenient way to access the API, as well as standard models, schemas, commands, and events.
+
+## Installation
+
+```bash
+npm install @kohost/api-client
+```
+
+## Usage
+
+The library consists of several modules, including:
+
+- Models: Defines the models used in the API.
+- Errors: Defines the error objects returned by the API.
+- Commands: Defines the available commands for managing hosting resources.
+- Events: Defines the events emitted by the API.
+- defs: Defines the API endpoint definitions.
+- utils: Contains utility functions.
+- Client: The main http client for interacting with the API
+
+```javascript
+import { Client } from "@kohost/api-client";
+
+const kohost = new Client({
+  url: "https://localhost:8080/v3",
+  propertyId: "development",
+});
+```
+
+## Authentication
+
+Currently, the only supported mode of Authentication with the API is via an HTTP Only cookie. You can login a user via the following command to get a cookie.
+
+### Requesting a Login Token
+
+```javascript
+const email = "help@kohost.io";
+
+await kohost.RequestLoginLink({
+  data: { email },
+});
+
+/** OR via Phone **/
+
+const phone = "+17025555555";
+
+await kohost.RequestLoginLink({
+  data: { phone },
+});
+```
+
+Click the link in the email or SMS to authenticate.
+
+### Using a Token
+
+Simply use the `LoginUser` use case to provide a user ID via the `sub` parameter, along with the `token` parameter.
+
+```javascript
+const sub = "user-id-from-api";
+const token = "token-provided-by-api";
+
+await kohost.LoginUser({
+  data: { sub, token },
+});
+```
+
+A successful response will set an HTTP only cookie in the browser.

package/dist/cjs/Client.js

@@ -1267,7 +1267,7 @@ var require_UpdateSpace = __commonJS({
         requestData = {};
       const pathParams = [":id"];
       const { data, query, headers } = requestData;
-      let url = "/spaces/:id";
+      let url = "/spaceTypes/:id";
       if (pathParams && data) {
         for (const param of pathParams) {
           const paramName = param.replace(":", "");
@@ -1335,6 +1335,158 @@ var require_CreateRoomInSpace = __commonJS({
   }
 });
 
+// dist/useCases/CreateSpaceType.js
+var require_CreateSpaceType = __commonJS({
+  "dist/useCases/CreateSpaceType.js"(exports2, module2) {
+    module2.exports = /* @__PURE__ */ __name(function CreateSpaceType2(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+      if (!requestData)
+        requestData = {};
+      const pathParams = null;
+      const { data, query, headers } = requestData;
+      let url = "/spaceTypes";
+      if (pathParams && data) {
+        for (const param of pathParams) {
+          const paramName = param.replace(":", "");
+          url = url.replace(param, data[paramName]);
+        }
+      }
+      if (url.match(/:[a-zA-Z0-9]+/g)) {
+        const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+        const missing = missingParams.map((param) => param.replace(":", ""));
+        return Promise.reject(
+          new Error("Missing parameters: " + missing.join(", "))
+        );
+      }
+      const config = {
+        method: "post",
+        url,
+        ...httpConfigOptions
+      };
+      if (data)
+        config.data = data;
+      if (query)
+        config.params = query;
+      if (headers)
+        config.headers = headers;
+      return this._http.request(config);
+    }, "CreateSpaceType");
+  }
+});
+
+// dist/useCases/DeleteSpaceType.js
+var require_DeleteSpaceType = __commonJS({
+  "dist/useCases/DeleteSpaceType.js"(exports2, module2) {
+    module2.exports = /* @__PURE__ */ __name(function DeleteSpaceType2(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+      if (!requestData)
+        requestData = {};
+      const pathParams = [":id"];
+      const { data, query, headers } = requestData;
+      let url = "/spaceTypes/:id";
+      if (pathParams && data) {
+        for (const param of pathParams) {
+          const paramName = param.replace(":", "");
+          url = url.replace(param, data[paramName]);
+        }
+      }
+      if (url.match(/:[a-zA-Z0-9]+/g)) {
+        const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+        const missing = missingParams.map((param) => param.replace(":", ""));
+        return Promise.reject(
+          new Error("Missing parameters: " + missing.join(", "))
+        );
+      }
+      const config = {
+        method: "delete",
+        url,
+        ...httpConfigOptions
+      };
+      if (data)
+        config.data = data;
+      if (query)
+        config.params = query;
+      if (headers)
+        config.headers = headers;
+      return this._http.request(config);
+    }, "DeleteSpaceType");
+  }
+});
+
+// dist/useCases/DescribeSpaceType.js
+var require_DescribeSpaceType = __commonJS({
+  "dist/useCases/DescribeSpaceType.js"(exports2, module2) {
+    module2.exports = /* @__PURE__ */ __name(function DescribeSpaceType2(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+      if (!requestData)
+        requestData = {};
+      const pathParams = [":id"];
+      const { data, query, headers } = requestData;
+      let url = "/spaceTypes/:id";
+      if (pathParams && data) {
+        for (const param of pathParams) {
+          const paramName = param.replace(":", "");
+          url = url.replace(param, data[paramName]);
+        }
+      }
+      if (url.match(/:[a-zA-Z0-9]+/g)) {
+        const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+        const missing = missingParams.map((param) => param.replace(":", ""));
+        return Promise.reject(
+          new Error("Missing parameters: " + missing.join(", "))
+        );
+      }
+      const config = {
+        method: "get",
+        url,
+        ...httpConfigOptions
+      };
+      if (data)
+        config.data = data;
+      if (query)
+        config.params = query;
+      if (headers)
+        config.headers = headers;
+      return this._http.request(config);
+    }, "DescribeSpaceType");
+  }
+});
+
+// dist/useCases/ListSpaceTypes.js
+var require_ListSpaceTypes = __commonJS({
+  "dist/useCases/ListSpaceTypes.js"(exports2, module2) {
+    module2.exports = /* @__PURE__ */ __name(function ListSpaceTypes2(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+      if (!requestData)
+        requestData = {};
+      const pathParams = null;
+      const { data, query, headers } = requestData;
+      let url = "/spaceTypes";
+      if (pathParams && data) {
+        for (const param of pathParams) {
+          const paramName = param.replace(":", "");
+          url = url.replace(param, data[paramName]);
+        }
+      }
+      if (url.match(/:[a-zA-Z0-9]+/g)) {
+        const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+        const missing = missingParams.map((param) => param.replace(":", ""));
+        return Promise.reject(
+          new Error("Missing parameters: " + missing.join(", "))
+        );
+      }
+      const config = {
+        method: "get",
+        url,
+        ...httpConfigOptions
+      };
+      if (data)
+        config.data = data;
+      if (query)
+        config.params = query;
+      if (headers)
+        config.headers = headers;
+      return this._http.request(config);
+    }, "ListSpaceTypes");
+  }
+});
+
 // dist/useCases/ListRooms.js
 var require_ListRooms = __commonJS({
   "dist/useCases/ListRooms.js"(exports2, module2) {
@@ -2399,6 +2551,44 @@ var require_DescribeDimmer = __commonJS({
   }
 });
 
+// dist/useCases/SetDimmer.js
+var require_SetDimmer = __commonJS({
+  "dist/useCases/SetDimmer.js"(exports2, module2) {
+    module2.exports = /* @__PURE__ */ __name(function SetDimmer2(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+      if (!requestData)
+        requestData = {};
+      const pathParams = [":roomId", ":id"];
+      const { data, query, headers } = requestData;
+      let url = "/rooms/:roomId/dimmers/:id";
+      if (pathParams && data) {
+        for (const param of pathParams) {
+          const paramName = param.replace(":", "");
+          url = url.replace(param, data[paramName]);
+        }
+      }
+      if (url.match(/:[a-zA-Z0-9]+/g)) {
+        const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+        const missing = missingParams.map((param) => param.replace(":", ""));
+        return Promise.reject(
+          new Error("Missing parameters: " + missing.join(", "))
+        );
+      }
+      const config = {
+        method: "post",
+        url,
+        ...httpConfigOptions
+      };
+      if (data)
+        config.data = data;
+      if (query)
+        config.params = query;
+      if (headers)
+        config.headers = headers;
+      return this._http.request(config);
+    }, "SetDimmer");
+  }
+});
+
 // dist/useCases/CreateLock.js
 var require_CreateLock = __commonJS({
   "dist/useCases/CreateLock.js"(exports2, module2) {
@@ -4869,6 +5059,82 @@ var require_BatchNotifyPreArrival = __commonJS({
   }
 });
 
+// dist/useCases/BatchNotifyCheckIn.js
+var require_BatchNotifyCheckIn = __commonJS({
+  "dist/useCases/BatchNotifyCheckIn.js"(exports2, module2) {
+    module2.exports = /* @__PURE__ */ __name(function BatchNotifyCheckIn2(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+      if (!requestData)
+        requestData = {};
+      const pathParams = null;
+      const { data, query, headers } = requestData;
+      let url = "/reservations/batchNotifyCheckIn";
+      if (pathParams && data) {
+        for (const param of pathParams) {
+          const paramName = param.replace(":", "");
+          url = url.replace(param, data[paramName]);
+        }
+      }
+      if (url.match(/:[a-zA-Z0-9]+/g)) {
+        const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+        const missing = missingParams.map((param) => param.replace(":", ""));
+        return Promise.reject(
+          new Error("Missing parameters: " + missing.join(", "))
+        );
+      }
+      const config = {
+        method: "post",
+        url,
+        ...httpConfigOptions
+      };
+      if (data)
+        config.data = data;
+      if (query)
+        config.params = query;
+      if (headers)
+        config.headers = headers;
+      return this._http.request(config);
+    }, "BatchNotifyCheckIn");
+  }
+});
+
+// dist/useCases/AssignSpaceToReservation.js
+var require_AssignSpaceToReservation = __commonJS({
+  "dist/useCases/AssignSpaceToReservation.js"(exports2, module2) {
+    module2.exports = /* @__PURE__ */ __name(function AssignSpaceToReservation2(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+      if (!requestData)
+        requestData = {};
+      const pathParams = [":id"];
+      const { data, query, headers } = requestData;
+      let url = "/reservations/:id/space";
+      if (pathParams && data) {
+        for (const param of pathParams) {
+          const paramName = param.replace(":", "");
+          url = url.replace(param, data[paramName]);
+        }
+      }
+      if (url.match(/:[a-zA-Z0-9]+/g)) {
+        const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+        const missing = missingParams.map((param) => param.replace(":", ""));
+        return Promise.reject(
+          new Error("Missing parameters: " + missing.join(", "))
+        );
+      }
+      const config = {
+        method: "post",
+        url,
+        ...httpConfigOptions
+      };
+      if (data)
+        config.data = data;
+      if (query)
+        config.params = query;
+      if (headers)
+        config.headers = headers;
+      return this._http.request(config);
+    }, "AssignSpaceToReservation");
+  }
+});
+
 // dist/useCases/OCRDocument.js
 var require_OCRDocument = __commonJS({
   "dist/useCases/OCRDocument.js"(exports2, module2) {
@@ -5019,6 +5285,10 @@ var DescribeSpace = require_DescribeSpace();
 var DeleteSpace = require_DeleteSpace();
 var UpdateSpace = require_UpdateSpace();
 var CreateRoomInSpace = require_CreateRoomInSpace();
+var CreateSpaceType = require_CreateSpaceType();
+var DeleteSpaceType = require_DeleteSpaceType();
+var DescribeSpaceType = require_DescribeSpaceType();
+var ListSpaceTypes = require_ListSpaceTypes();
 var ListRooms = require_ListRooms();
 var DescribeRoom = require_DescribeRoom();
 var CreateRoom = require_CreateRoom();
@@ -5047,6 +5317,7 @@ var ListDimmers = require_ListDimmers();
 var UpdateDimmer = require_UpdateDimmer();
 var DeleteDimmer = require_DeleteDimmer();
 var DescribeDimmer = require_DescribeDimmer();
+var SetDimmer = require_SetDimmer();
 var CreateLock = require_CreateLock();
 var ListLocks = require_ListLocks();
 var UpdateLock = require_UpdateLock();
@@ -5112,6 +5383,8 @@ var CheckInReservation = require_CheckInReservation();
 var SendPreArrivalSMS = require_SendPreArrivalSMS();
 var SendPreArrivalEmail = require_SendPreArrivalEmail();
 var BatchNotifyPreArrival = require_BatchNotifyPreArrival();
+var BatchNotifyCheckIn = require_BatchNotifyCheckIn();
+var AssignSpaceToReservation = require_AssignSpaceToReservation();
 var OCRDocument = require_OCRDocument();
 var DescribeMyProperty = require_DescribeMyProperty();
 var EmailUserAccountSetup = require_EmailUserAccountSetup();
@@ -5196,6 +5469,10 @@ var KohostApiClient = class extends EventEmitter {
     try {
       const expectedError = status >= 400 && status < 500;
       const newTokensNeeded = expectedError && errorType === "TokenExpiredError";
+      if (expectedError && errorMessage === "Phone Verification is required") {
+        this._onPhoneVerificationRequired();
+        return Promise.reject(error);
+      }
       if (expectedError && errorMessage === "Login Required") {
         this._onLoginRequired();
         return Promise.reject(error);
@@ -5236,6 +5513,9 @@ var KohostApiClient = class extends EventEmitter {
   _onLoginRequired() {
     this.emit("LoginRequired");
   }
+  _onPhoneVerificationRequired() {
+    this.emit("PhoneVerificationRequired");
+  }
 };
 __name(KohostApiClient, "KohostApiClient");
 KohostApiClient.prototype.AdminCreateCustomer = AdminCreateCustomer;
@@ -5273,6 +5553,10 @@ KohostApiClient.prototype.DescribeSpace = DescribeSpace;
 KohostApiClient.prototype.DeleteSpace = DeleteSpace;
 KohostApiClient.prototype.UpdateSpace = UpdateSpace;
 KohostApiClient.prototype.CreateRoomInSpace = CreateRoomInSpace;
+KohostApiClient.prototype.CreateSpaceType = CreateSpaceType;
+KohostApiClient.prototype.DeleteSpaceType = DeleteSpaceType;
+KohostApiClient.prototype.DescribeSpaceType = DescribeSpaceType;
+KohostApiClient.prototype.ListSpaceTypes = ListSpaceTypes;
 KohostApiClient.prototype.ListRooms = ListRooms;
 KohostApiClient.prototype.DescribeRoom = DescribeRoom;
 KohostApiClient.prototype.CreateRoom = CreateRoom;
@@ -5301,6 +5585,7 @@ KohostApiClient.prototype.ListDimmers = ListDimmers;
 KohostApiClient.prototype.UpdateDimmer = UpdateDimmer;
 KohostApiClient.prototype.DeleteDimmer = DeleteDimmer;
 KohostApiClient.prototype.DescribeDimmer = DescribeDimmer;
+KohostApiClient.prototype.SetDimmer = SetDimmer;
 KohostApiClient.prototype.CreateLock = CreateLock;
 KohostApiClient.prototype.ListLocks = ListLocks;
 KohostApiClient.prototype.UpdateLock = UpdateLock;
@@ -5366,6 +5651,8 @@ KohostApiClient.prototype.CheckInReservation = CheckInReservation;
 KohostApiClient.prototype.SendPreArrivalSMS = SendPreArrivalSMS;
 KohostApiClient.prototype.SendPreArrivalEmail = SendPreArrivalEmail;
 KohostApiClient.prototype.BatchNotifyPreArrival = BatchNotifyPreArrival;
+KohostApiClient.prototype.BatchNotifyCheckIn = BatchNotifyCheckIn;
+KohostApiClient.prototype.AssignSpaceToReservation = AssignSpaceToReservation;
 KohostApiClient.prototype.OCRDocument = OCRDocument;
 KohostApiClient.prototype.DescribeMyProperty = DescribeMyProperty;
 KohostApiClient.prototype.EmailUserAccountSetup = EmailUserAccountSetup;

package/dist/cjs/Commands.js

@@ -567,8 +567,15 @@ var require_DiscoverRoomsCommand = __commonJS({
   "src/Commands/DiscoverRoomsCommand.js"(exports2, module2) {
     var Command = require_Command();
     var DiscoverRoomsCommand2 = class extends Command {
-      constructor({ id }) {
-        super({ id });
+      constructor({
+        id,
+        types,
+        startDate,
+        endDate,
+        serviceStatus,
+        housekeepingStatus
+      }) {
+        super({ id, types, startDate, endDate, serviceStatus, housekeepingStatus });
       }
       get name() {
         return "DiscoverRooms";
@@ -589,6 +596,33 @@ var require_DiscoverRoomsCommand = __commonJS({
   }
 });
 
+// src/Commands/DiscoverRoomTypesCommand.js
+var require_DiscoverRoomTypesCommand = __commonJS({
+  "src/Commands/DiscoverRoomTypesCommand.js"(exports2, module2) {
+    var Command = require_Command();
+    var DiscoverRoomTypesCommand2 = class extends Command {
+      constructor({ id }) {
+        super({ id });
+      }
+      get name() {
+        return "DiscoverRoomTypes";
+      }
+      get routingKey() {
+        if (typeof this.data.id === "string")
+          return `rooms.${this.data.id}.get`;
+        if (Array.isArray(this.data.id))
+          return "rooms.batch.get";
+        return "rooms.get";
+      }
+      get replyTo() {
+        return "system.response.users";
+      }
+    };
+    __name(DiscoverRoomTypesCommand2, "DiscoverRoomTypesCommand");
+    module2.exports = DiscoverRoomTypesCommand2;
+  }
+});
+
 // src/Commands/CreateShortLinkCommand.js
 var require_CreateShortLinkCommand = __commonJS({
   "src/Commands/CreateShortLinkCommand.js"(exports2, module2) {
@@ -614,6 +648,32 @@ var require_CreateShortLinkCommand = __commonJS({
   }
 });
 
+// src/Commands/UpdateReservationCommand.js
+var require_UpdateReservationCommand = __commonJS({
+  "src/Commands/UpdateReservationCommand.js"(exports2, module2) {
+    var Command = require_Command();
+    var RequestError = require_RequestError();
+    var UpdateReservationCommand2 = class extends Command {
+      constructor({ id, space }) {
+        if (!id)
+          throw new RequestError("document type is required");
+        super({ id, space });
+      }
+      get name() {
+        return "UpdateReservation";
+      }
+      get routingKey() {
+        return `reservation.${this.data.id}.update`;
+      }
+      get replyTo() {
+        return "system.response.reservations";
+      }
+    };
+    __name(UpdateReservationCommand2, "UpdateReservationCommand");
+    module2.exports = UpdateReservationCommand2;
+  }
+});
+
 // src/Commands/index.js
 var SetAlarmCommand = require_SetAlarmCommand();
 var SetDimmerCommand = require_SetDimmerCommand();
@@ -630,7 +690,9 @@ var SendEmailCommand = require_SendEmailCommand();
 var SendSMSCommand = require_SendSMSCommand();
 var DiscoverReservationsCommand = require_DiscoverReservationsCommand();
 var DiscoverRoomsCommand = require_DiscoverRoomsCommand();
+var DiscoverRoomTypesCommand = require_DiscoverRoomTypesCommand();
 var CreateShortLinkCommand = require_CreateShortLinkCommand();
+var UpdateReservationCommand = require_UpdateReservationCommand();
 module.exports = {
   SetAlarmCommand,
   SetDimmerCommand,
@@ -647,5 +709,7 @@ module.exports = {
   SendEmailCommand,
   DiscoverReservationsCommand,
   DiscoverRoomsCommand,
-  CreateShortLinkCommand
+  DiscoverRoomTypesCommand,
+  CreateShortLinkCommand,
+  UpdateReservationCommand
 };