@kohost/api-client 3.9.12 → 4.0.4

package/dist/cjs/schemas/policy.json

@@ -1,62 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "policy.json",
-  "title": "Policy",
-  "description": "A policy is a set of permissions that can be applied to a user to limit their access to resources.",
-  "type": "object",
-  "required": [
-    "name",
-    "type",
-    "organizationId",
-    "propertyId",
-    "permissions",
-    "discriminator"
-  ],
-  "properties": {
-    "id": {
-      "$ref": "definitions.json#/definitions/id"
-    },
-    "type": {
-      "type": "string",
-      "default": "policy",
-      "enum": ["policy"]
-    },
-    "discriminator": {
-      "type": "string",
-      "enum": ["user"]
-    },
-    "name": {
-      "type": "string",
-      "minLength": 1
-    },
-    "description": {
-      "type": "string"
-    },
-    "organizationId": {
-      "type": "string"
-    },
-    "propertyId": {
-      "type": "string"
-    },
-    "permissions": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "required": ["entities", "effect"],
-        "properties": {
-          "entities": {
-            "type": "array",
-            "items": {
-              "type": "string",
-              "pattern": "^[^:]+(:.+)+$"
-            }
-          },
-          "effect": {
-            "type": "string",
-            "enum": ["Allow", "Deny"]
-          }
-        }
-      }
-    }
-  }
-}

package/dist/cjs/schemas/product.json

@@ -1,45 +0,0 @@
-{
-  "$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",
-      "default": "product",
-      "enum": ["product"]
-    },
-    "name": {
-      "type": "string"
-    },
-    "driver": {
-      "$ref": "definitions.json#/definitions/driver"
-    },
-    "description": {
-      "string": "string"
-    },
-    "price": {
-      "type": "number"
-    },
-    "tax": {
-      "type": ["number", "null"]
-    },
-    "image": {
-      "$ref": "mediaFile.json"
-    },
-    "category": {
-      "type": "string"
-    },
-    "imageUrl": {
-      "format": "uri",
-      "pattern": "^https?://"
-    },
-    "systemId": {
-      "$ref": "definitions.json#/definitions/systemId"
-    }
-  }
-}

package/dist/cjs/schemas/property.json

@@ -1,430 +0,0 @@
-{
-  "$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",
-    "organization",
-    "timezone",
-    "discriminator"
-  ],
-  "properties": {
-    "id": {
-      "$ref": "definitions.json#/definitions/id"
-    },
-    "name": {
-      "type": "string"
-    },
-    "type": {
-      "type": "string",
-      "default": "property",
-      "enum": ["property"]
-    },
-    "discriminator": {
-      "type": "string",
-      "enum": ["hospitality", "education", "commercial", "storage"]
-    },
-    "organization": {
-      "type": ["string", "null"],
-      "description": "Reference (id) to the organization that owns this property"
-    },
-    "departments": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "testModeEnabled": {
-      "type": "boolean"
-    },
-    "testMode": {
-      "type": "object",
-      "properties": {
-        "notificationEmails": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "Only users with these email addresses will receive notifications in test mode, including sms, email, or push."
-        },
-        "notificationEmailDomains": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "Only users with email addreses ending in these domains will receive notifications in test mode, including sms, email, or push."
-        }
-      }
-    },
-    "timezone": {
-      "type": "string",
-      "description": "IANA timezone string",
-      "pattern": "^([a-zA-Z]+/[a-zA-Z_]+)$",
-      "examples": ["America/New_York", "America/Los_Angeles"]
-    },
-    "smsNumber": {
-      "type": "string"
-    },
-    "checkInTime": {
-      "type": "string"
-    },
-    "checkOutTime": {
-      "type": "string"
-    },
-    "address": {
-      "$ref": "definitions.json#/definitions/address"
-    },
-    "latitude": {
-      "type": "number"
-    },
-    "longitude": {
-      "type": "number"
-    },
-    "appFeatures": {
-      "type": "object",
-      "properties": {
-        "RoomControl": {
-          "type": "object",
-          "properties": {
-            "disabledSystems": {
-              "type": "array",
-              "items": {
-                "type": "string",
-                "enum": ["climate", "lights", "shades", "tv", "doors"]
-              }
-            },
-            "commonAreas": {
-              "type": "object",
-              "properties": {
-                "spaces": {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  }
-                }
-              }
-            },
-            "alarmConfig": {
-              "type": "object",
-              "patternProperties": {
-                "^[a-zA-Z0-9]+$": {
-                  "type": "object",
-                  "properties": {
-                    "zoneLockMap": {
-                      "type": "object",
-                      "description": "Maps zone numbers to lock ids",
-                      "additionalProperties": { "type": "string" }
-                    }
-                  }
-                }
-              },
-              "examples": [
-                {
-                  "wZz7hucY": {
-                    "zoneLockMap": {
-                      "1": "wc87hucc",
-                      "2": "bc86hzxc",
-                      "3": "zv5ah5jv"
-                    }
-                  }
-                }
-              ]
-            }
-          },
-          "additionalProperties": false
-        },
-        "CheckIn": {
-          "properties": {
-            "payment": {},
-            "identification": {},
-            "earlyCheckIn": {
-              "type": "object",
-              "required": ["dynamic"],
-              "properties": {
-                "dynamic": {
-                  "type": "boolean",
-                  "default": false
-                },
-                "minimumPrice": {
-                  "type": "number",
-                  "default": 10
-                },
-                "maximumPrice": {
-                  "type": "number",
-                  "default": 50
-                },
-                "priceRatioPerHour": {
-                  "type": "number",
-                  "default": 0.1
-                },
-                "minimumTime": {
-                  "type": "string"
-                }
-              }
-            },
-            "roomUpgrades": {},
-            "pet": {},
-            "promos": {}
-          }
-        },
-        "CheckOut": {
-          "properties": {
-            "lateCheckOut": {
-              "type": "object",
-              "required": ["dynamic"],
-              "properties": {
-                "dynamic": {
-                  "type": "boolean",
-                  "default": false
-                },
-                "minimumPrice": {
-                  "type": "number",
-                  "default": 10
-                },
-                "maximumPrice": {
-                  "type": "number",
-                  "default": 50
-                },
-                "priceRatioPerHour": {
-                  "type": "number",
-                  "default": 0.1
-                }
-              }
-            }
-          }
-        },
-        "Concierge": {
-          "type": "object",
-          "properties": {
-            "timeTracking": {
-              "type": "boolean",
-              "default": false
-            },
-            "tipping": {
-              "type": "boolean",
-              "default": false
-            },
-            "ratings": {
-              "type": "boolean",
-              "default": true
-            },
-            "newTicketCCs": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "default": []
-            },
-            "newMessageChannel": {
-              "type": ["string", "null"],
-              "enum": ["sms", "email"],
-              "default": "sms",
-              "description": "Determines how users should be notified of new messages in the concierge system"
-            },
-            "quickServices": {
-              "type": "array",
-              "items": {
-                "type": "object",
-                "properties": {
-                  "name": {
-                    "type": "string"
-                  },
-                  "description": {
-                    "type": "string"
-                  },
-                  "department": {
-                    "type": "string"
-                  },
-                  "image": {
-                    "$ref": "mediaFile.json"
-                  }
-                },
-                "required": ["name", "description", "image"]
-              }
-            },
-            "issues": {
-              "type": "object",
-              "properties": {
-                "syncWithPropertyId": {
-                  "type": "string"
-                }
-              }
-            }
-          }
-        },
-        "DigitalKey": {
-          "type": "object",
-          "properties": {
-            "system": {
-              "type": "string",
-              "enum": ["salto", "dormakaba"]
-            },
-            "systemOnline": {
-              "type": "boolean",
-              "default": false
-            },
-            "systemConfig": {
-              "type": "object",
-              "properties": {
-                "legicUrl": {
-                  "type": "string",
-                  "format": "uri"
-                },
-                "legicWalletName": {
-                  "type": "string"
-                },
-                "legicAppId": {
-                  "type": "number"
-                },
-                "legicTechUsername": {
-                  "type": "string"
-                },
-                "legicTechPassword": {
-                  "type": "string"
-                }
-              },
-              "additionalProperties": false,
-              "default": {}
-            },
-            "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
-                }
-              }
-            }
-          }
-        },
-        "SOS": {
-          "type": "object",
-          "properties": {
-            "active": {
-              "type": "boolean"
-            },
-            "activeEmergencies": {
-              "type": "array",
-              "items": {
-                "type": "string",
-                "enum": [
-                  "medical",
-                  "fire",
-                  "suspiciousPerson",
-                  "other",
-                  "conflict",
-                  "shooter"
-                ]
-              }
-            }
-          }
-        },
-        "Elevator": {},
-        "Experiences": {},
-        "Dining": {
-          "type": "object",
-          "properties": {
-            "system": {
-              "type": "string",
-              "enum": ["gotab"]
-            },
-            "systemConfig": {
-              "type": "object",
-              "properties": {
-                "landingUrl": {
-                  "type": "string",
-                  "format": "uri"
-                },
-                "includeUserDetails": {
-                  "type": "boolean"
-                }
-              },
-              "additionalProperties": false
-            }
-          }
-        },
-        "Rentals": {},
-        "Shop": {},
-        "Spa": {},
-        "Valet": {}
-      },
-      "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
-    }
-  }
-}

package/dist/cjs/schemas/reservation.json

@@ -1,146 +0,0 @@
-{
-  "$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",
-      "enum": ["reservation"]
-    },
-    "sharedGuests": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "spaceCategory": {
-      "type": "string"
-    },
-    "space": {
-      "type": ["string", "null"]
-    },
-    "previousSpace": {
-      "type": ["string", "null"],
-      "default": null,
-      "description": "Used when there was a space assigned and it changes"
-    },
-    "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)"
-    },
-    "mobileCheckInSpaceCategoryChanged": {
-      "type": "boolean",
-      "description": "spaceCategory has changed from original."
-    },
-    "mobileCheckInSpaceChanged": {
-      "type": "boolean"
-    },
-    "mobileCheckInStatus": {
-      "type": "string",
-      "enum": [
-        "ready",
-        "blocked",
-        "preArrivalStepsRequired",
-        "spaceNotAssigned",
-        "spaceNotReady",
-        "checkInTimeNotStarted"
-      ]
-    },
-    "mobileCheckInStatusMessage": {
-      "type": "string"
-    },
-    "confirmationNumber": {
-      "type": "string"
-    },
-    "expectedCheckInDateTime": {
-      "type": ["string", "object"],
-      "format": "date-time",
-      "description": "Expected arrival time of guest."
-    },
-    "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"]
-          },
-          "isUpgrade": {
-            "type": "boolean"
-          }
-        }
-      }
-    },
-    "revenue": {
-      "$ref": "definitions.json#/definitions/revenue"
-    },
-    "rateSuppressed": {
-      "type": "boolean"
-    },
-    "payment": {
-      "type": "string"
-    },
-    "company": {
-      "type": "string"
-    },
-    "travelAgent": {
-      "type": "string"
-    },
-    "systemId": {
-      "$ref": "definitions.json#/definitions/systemId"
-    },
-    "metadata": {
-      "ref": "definitions.json#/definitions/metadata"
-    },
-    "updatedAt": {
-      "$ref": "definitions.json#/definitions/updatedAt"
-    }
-  }
-}