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

package/dist/cjs/schemas/order.json

@@ -0,0 +1,182 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "order.json",
+  "title": "Order",
+  "description": "A purchase order for products or services.",
+  "type": "object",
+  "required": ["type", "status"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "default": "order"
+    },
+    "orderNumber": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "draft",
+        "pendingPayment",
+        "processing",
+        "outForDelivery",
+        "completed",
+        "paymentFailed",
+        "cancelled",
+        "refunded"
+      ]
+    },
+    "user": {
+      "$ref": "definitions.json#/definitions/id",
+      "description": "User id of purchaser"
+    },
+    "date": {
+      "$ref": "definitions.json#/definitions/date"
+    },
+    "items": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "required": ["name", "price"],
+        "properties": {
+          "additionalProperties": false,
+          "name": {
+            "type": "string"
+          },
+          "sku": {
+            "type": "string"
+          },
+          "quantity": {
+            "type": "number",
+            "default": 1
+          },
+          "price": {
+            "type": "number"
+          },
+          "taxClass": {
+            "type": "string"
+          },
+          "deliveryClass": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "taxes": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "required": ["name", "rate"],
+        "properties": {
+          "additionalProperties": false,
+          "name": {
+            "type": "string"
+          },
+          "class": {
+            "type": "string"
+          },
+          "rateType": {
+            "type": "string",
+            "enum": ["percentage", "flat"],
+            "default": "percentage"
+          },
+          "rate": {
+            "type": "number"
+          },
+          "total": {
+            "type": "number"
+          }
+        }
+      }
+    },
+    "fees": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "required": ["name", "price"],
+        "properties": {
+          "additionalProperties": false,
+          "name": {
+            "type": "string"
+          },
+          "price": {
+            "type": "number"
+          }
+        }
+      }
+    },
+    "delivery": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "required": ["name", "rate"],
+        "properties": {
+          "additionalProperties": false,
+          "name": {
+            "type": "string"
+          },
+          "class": {
+            "type": "string"
+          },
+          "rateType": {
+            "type": "string",
+            "enum": ["percentage", "flat"],
+            "default": "percentage"
+          },
+          "rate": {
+            "type": "number"
+          },
+          "total": {
+            "type": "number"
+          }
+        }
+      }
+    },
+    "payments": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "properties": {
+          "method": {
+            "type": "string",
+            "enum": [
+              "folio",
+              "invoice",
+              "amex",
+              "visa",
+              "masterCard",
+              "maestro",
+              "discover",
+              "diners",
+              "jcb",
+              "applePay",
+              "alipay",
+              "chinaUnionPay",
+              "vpay"
+            ]
+          },
+          "name": {
+            "type": "string"
+          },
+          "date": {
+            "$ref": "definitions.json#/definitions/date"
+          },
+          "amount": {
+            "type": "number"
+          },
+          "transactionReference": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

package/dist/cjs/schemas/organization.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "organization.json",
+  "title": "Organization",
+  "type": "object",
+  "description": "An organization is a group or entity that subscribes to Kohost software.",
+  "required": ["accountNumber", "name"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "accountNumber": {
+      "type": "number",
+      "minimum": 10000
+    },
+    "name": {
+      "type": "string"
+    },
+    "properties": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "credentials": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "createdAt": {
+      "$ref": "definitions.json#/definitions/createdAt"
+    },
+    "updatedAt": {
+      "$ref": "definitions.json#/definitions/updatedAt"
+    }
+  }
+}

package/dist/cjs/schemas/payment.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "payment.json",
+  "title": "Payment",
+  "type": "object",
+  "required": ["type", "maskedNumber", "expires"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "amex",
+        "visa",
+        "masterCard",
+        "maestro",
+        "discover",
+        "diners",
+        "jcb",
+        "applePay",
+        "alipay",
+        "chinaUnionPay",
+        "vpay"
+      ]
+    },
+    "enabled": {
+      "type": "boolean",
+      "default": true
+    },
+    "storageData": {
+      "type": ["string", "null"]
+    },
+    "maskedNumber": {
+      "string": "string"
+    },
+    "issued": {
+      "type": ["string", "null"]
+    },
+    "expires": {
+      "string": "string"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    }
+  }
+}

package/dist/cjs/schemas/product.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "product.json",
+  "title": "Product",
+  "type": "object",
+  "required": ["name", "price", "driver"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "description": {
+      "string": "string"
+    },
+    "price": {
+      "type": "number"
+    },
+    "image": {
+      "$ref": "definitions.json#/definitions/file"
+    },
+    "category": {
+      "type": "string"
+    },
+    "imageUrl": {
+      "format": "uri",
+      "pattern": "^https?://"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    }
+  }
+}

package/dist/cjs/schemas/property.json

@@ -0,0 +1,306 @@
+{
+  "$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
+            },
+            "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
+  }
+}