@kohost/api-client 3.0.0-beta.6 → 3.0.0-beta.61

package/dist/cjs/schemas/property.json

@@ -0,0 +1,309 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "property.json",
+  "title": "Property",
+  "type": "object",
+  "description": "A property is a physical asset or building",
+  "required": ["id", "name", "type", "hostname", "organization"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["hospitality", "education", "commercial"]
+    },
+    "timezone": {
+      "type": "string"
+    },
+    "smsNumber": {
+      "type": "string"
+    },
+    "hostname": {
+      "type": "string"
+    },
+    "organization": {
+      "type": "string",
+      "description": "Reference (id) to the organization that owns this property"
+    },
+    "address": {
+      "type": "object",
+      "properties": {
+        "street": {
+          "type": "string"
+        },
+        "city": {
+          "type": "string"
+        },
+        "state": {
+          "type": "string"
+        },
+        "zip": {
+          "type": "string"
+        },
+        "country": {
+          "type": "string"
+        }
+      }
+    },
+    "latitude": {
+      "type": "number"
+    },
+    "longitude": {
+      "type": "number"
+    },
+    "appManifest": {
+      "type": "object",
+
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "short_name": {
+          "type": "string"
+        },
+        "scope": {
+          "type": "string"
+        },
+        "start_url": {
+          "type": "string"
+        },
+        "themeColor": {
+          "type": "string"
+        },
+        "backgroundColor": {
+          "type": "string"
+        },
+        "display": {
+          "type": "string",
+          "enum": ["fullscreen", "standalone", "minimal-ui", "browser"],
+          "default": "fullscreen"
+        },
+        "orientation": {
+          "type": "string",
+          "enum": ["portrait", "landscape"],
+          "default": "portrait"
+        },
+        "splash": {
+          "type": "object",
+          "properties": {
+            "src": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "sizes": {
+              "type": "string"
+            }
+          }
+        },
+        "icons": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "src": {
+                "type": "string"
+              },
+              "sizes": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "logo": {
+          "type": "object",
+          "properties": {
+            "src": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "sizes": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "default": {
+        "name": "Kohost",
+        "short_name": "Kohost",
+        "start_url": "/",
+        "scope": "/",
+        "display": "fullscreen",
+        "orientation": "portrait",
+        "theme_color": "#1d1f22",
+        "background_color": "#1d1f22",
+        "icons": [
+          {
+            "src": "https://cdn.kohost.app/defaultIcon.png",
+            "sizes": "512x512",
+            "type": "image/png"
+          }
+        ],
+        "splash": {
+          "src": "https://cdn.kohost.app/defaultSplash.jpg",
+          "sizes": "1500x800",
+          "type": "image/jpg"
+        },
+        "logo": {
+          "src": "https://cdn.kohost.app/defaultLogo.png",
+          "sizes": "300x75",
+          "type": "image/png"
+        }
+      }
+    },
+    "appFeatures": {
+      "type": "object",
+      "properties": {
+        "RoomControl": {
+          "type": "object",
+          "properties": {
+            "commonAreas": {
+              "type": "object",
+              "properties": {
+                "spaces": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "CheckIn": {
+          "properties": {
+            "payment": {},
+            "identification": {},
+            "earlyCheckIn": {
+              "type": "object",
+              "required": ["dynamic", "checkInTime", "checkOutTime"],
+              "properties": {
+                "dynamic": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "checkInTime": {
+                  "type": "string"
+                },
+                "checkOutTime": {
+                  "type": "string"
+                }
+              }
+            },
+            "roomUpgrades": {}
+          }
+        },
+        "CheckOut": {},
+        "Concierge": {},
+        "DigitalKey": {
+          "type": "object",
+          "properties": {
+            "system": {
+              "type": "string",
+              "enum": ["salto"]
+            },
+            "systemOnline": {
+              "type": "boolean",
+              "default": false
+            },
+            "enableApp": {
+              "type": "boolean"
+            },
+            "branding": {
+              "type": "object",
+              "properties": {
+                "logo": {
+                  "type": "string",
+                  "format": "uri"
+                },
+                "gradient": {
+                  "type": "array",
+                  "items": {
+                    "type": "string",
+                    "pattern": "^(?!#ffffff)(#[0-9a-fA-F]{6})$"
+                  },
+                  "minItems": 2,
+                  "maxItems": 2
+                },
+                "highlightedGradient": {
+                  "type": "array",
+                  "items": {
+                    "type": "string",
+                    "pattern": "^(?!#ffffff)(#[0-9a-fA-F]{6})$"
+                  },
+                  "minItems": 2,
+                  "maxItems": 3
+                }
+              }
+            }
+          }
+        },
+        "Elevator": {}
+      },
+      "additionalProperties": false,
+      "default": {
+        "RoomControl": {}
+      }
+    },
+    "notifications": {
+      "type": "object",
+      "properties": {
+        "email": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean"
+            }
+          },
+          "additionalProperties": false
+        },
+        "sms": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean"
+            }
+          },
+          "additionalProperties": false
+        },
+        "push": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false,
+      "default": {
+        "email": {
+          "enabled": false
+        },
+        "sms": {
+          "enabled": false
+        },
+        "push": {
+          "enabled": false
+        }
+      }
+    },
+    "credentials": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "additionalProperties": false
+  }
+}

package/dist/cjs/schemas/reservation.json

@@ -0,0 +1,141 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "reservation.json",
+  "title": "Reservation",
+  "type": "object",
+  "required": ["type", "status", "checkInDateTime", "checkOutDateTime"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "primaryGuest": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string",
+      "default": "reservation"
+    },
+    "sharedGuests": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "spaceCategory": {
+      "type": "string"
+    },
+    "space": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "reserved",
+        "checkedIn",
+        "checkedOut",
+        "cancelled",
+        "noShow",
+        "enquired",
+        "requested",
+        "optional"
+      ],
+      "description": " reserved - confirmed by both parties, before check-in\n checkedIn - checked in\n checkedOut - checked out\n cancelled - Cancelled\n noShow - No show\n enquired - Confirmed neither by the customer nor enterprise\n requested - Confirmed by the customer but not the enterprise (waitlist)\n optional - Confirmed by the enterprise but not the customer (holding)"
+    },
+    "mobileCheckInStatus": {
+      "type": "string",
+      "enum": [
+        "ready",
+        "blocked",
+        "preArrivalStepsRequired",
+        "spaceNotAssigned",
+        "spaceNotReady",
+        "checkInTimeNotStarted"
+      ]
+    },
+    "mobileCheckInStatusMessage": {
+      "type": "string"
+    },
+    "confirmationNumber": {
+      "type": "string"
+    },
+    "checkInDateTime": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "checkOutDateTime": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "adultCount": {
+      "type": "number",
+      "default": 1,
+      "minimum": 1
+    },
+    "childCount": {
+      "type": "number",
+      "default": 0
+    },
+
+    "spaceCategoryAvailabilites": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "price": {
+            "type": "number"
+          },
+          "unit": {
+            "type": "string",
+            "enum": ["night", "stay", "hour"]
+          }
+        }
+      }
+    },
+    "revenue": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "date": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "amount": {
+            "type": "number"
+          },
+          "type": {
+            "type": "string",
+            "enum": ["service", "product"]
+          }
+        }
+      }
+    },
+    "rateSuppressed": {
+      "type": "boolean"
+    },
+    "payment": {
+      "type": "string"
+    },
+    "company": {
+      "type": "string"
+    },
+    "travelAgent": {
+      "type": "string"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    },
+    "metadata": {
+      "ref": "definitions.json#/definitions/metadata"
+    },
+    "updatedAt": {
+      "$ref": "definitions.json#/definitions/updatedAt"
+    }
+  }
+}

package/dist/cjs/schemas/room.json

@@ -0,0 +1,98 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "room.json",
+  "title": "Room",
+  "description": "A room represents a physical space of controllable IoT devices",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "floor": {
+      "type": "string"
+    },
+    "dimmers": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "dimmer.json"
+      }
+    },
+    "switches": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "switch.json"
+      }
+    },
+    "thermostats": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "thermostat.json"
+      }
+    },
+    "locks": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "lock.json"
+      }
+    },
+    "windowCoverings": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "windowCovering.json"
+      }
+    },
+    "courtesy": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "courtesy.json"
+      }
+    },
+    "cameras": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "camera.json"
+      }
+    },
+    "mediaSources": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "mediaSource.json"
+      }
+    },
+    "motionSensors": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "motionSensor.json"
+      }
+    },
+    "alarms": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "alarm.json"
+      }
+    },
+    "occupiedAt": {
+      "$ref": "definitions.json#/definitions/createdAt"
+    },
+    "createdAt": {
+      "$ref": "definitions.json#/definitions/createdAt"
+    },
+    "updatedAt": {
+      "$ref": "definitions.json#/definitions/updatedAt"
+    }
+  },
+  "additionalProperties": false
+}

package/dist/cjs/schemas/scene.json

@@ -0,0 +1,121 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "scene.json",
+  "title": "Scene",
+  "description": "A room represents a physical space of controllable IoT devices",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "devices": {
+      "type": "object",
+      "properties": {
+        "switches": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "definitions.json#/definitions/id"
+              },
+              "state": {
+                "$ref": "switch.json#/properties/state"
+              }
+            },
+            "default": []
+          }
+        },
+        "dimmers": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "definitions.json#/definitions/id"
+              },
+              "level": {
+                "$ref": "dimmer.json#/properties/level"
+              }
+            }
+          },
+          "default": []
+        },
+        "windowCoverings": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "definitions.json#/definitions/id"
+              },
+              "position": {
+                "$ref": "windowCovering.json#/properties/position"
+              }
+            }
+          },
+          "default": []
+        },
+        "thermostats": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "definitions.json#/definitions/id"
+              },
+              "hvacMode": {
+                "$ref": "thermostat.json#/properties/hvacMode"
+              },
+              "setpoints": {
+                "$ref": "thermostat.json#/properties/setpoints"
+              },
+              "fanMode": {
+                "$ref": "thermostat.json#/properties/fanMode"
+              },
+              "setpointDelta": {
+                "type": "number"
+              }
+            }
+          },
+          "default": []
+        },
+        "mediaSources": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "definitions.json#/definitions/id"
+              },
+              "volume": {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 100
+              },
+              "commands": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "isDefault": {
+      "type": "boolean",
+      "default": false
+    },
+    "showOnUi": {
+      "type": "boolean",
+      "default": true
+    }
+  },
+  "additionalProperties": false
+}

package/dist/cjs/schemas/shortLink.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "shortLink.json",
+  "title": "Short Link",
+  "type": "object",
+  "required": ["destination", "url"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "default": "shortLink"
+    },
+    "title": {
+      "type": "string"
+    },
+    "destination": {
+      "string": "string",
+      "format": "uri"
+    },
+    "url": {
+      "string": "string",
+      "format": "uri"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    }
+  }
+}