@kohost/api-client 3.0.0-beta.5 → 3.0.0-beta.50
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +71 -0
- package/dist/cjs/AMQPClient/index.js +290 -0
- package/dist/cjs/{Client.js → Client/index.js} +1938 -986
- package/dist/cjs/Commands/CheckInReservationCommand.js +19 -0
- package/dist/cjs/Commands/Command.js +34 -0
- package/dist/cjs/Commands/CreateImageUploadEndpointCommand.js +17 -0
- package/dist/cjs/Commands/CreateShortLinkCommand.js +20 -0
- package/dist/cjs/Commands/DiscoverReservationRoomTypeUpsellOptionsCommand.js +20 -0
- package/dist/cjs/Commands/DiscoverReservationsCommand.js +20 -0
- package/dist/cjs/Commands/DiscoverRoomTypesCommand.js +19 -0
- package/dist/cjs/Commands/DiscoverRoomsCommand.js +35 -0
- package/dist/cjs/Commands/DiscoverUsersCommand.js +19 -0
- package/dist/cjs/Commands/GetMobileKeyCommand.js +24 -0
- package/dist/cjs/Commands/GetProductsCommand.js +17 -0
- package/dist/cjs/Commands/OCRDocumentCommand.js +15 -0
- package/dist/cjs/Commands/SellProductsCommand.js +17 -0
- package/dist/cjs/Commands/SendEmailCommand.js +24 -0
- package/dist/cjs/Commands/SendSMSCommand.js +21 -0
- package/dist/cjs/Commands/SetAlarmCommand.js +17 -0
- package/dist/cjs/Commands/SetCourtesyCommand.js +17 -0
- package/dist/cjs/Commands/SetDimmerCommand.js +17 -0
- package/dist/cjs/Commands/SetLockCommand.js +17 -0
- package/dist/cjs/Commands/SetMediaCommand.js +17 -0
- package/dist/cjs/Commands/SetSceneCommand.js +17 -0
- package/dist/cjs/Commands/SetSwitchCommand.js +17 -0
- package/dist/cjs/Commands/SetThermostatCommand.js +17 -0
- package/dist/cjs/Commands/SetWindowCoveringCommand.js +17 -0
- package/dist/cjs/Commands/UpdateReservationCommand.js +19 -0
- package/dist/cjs/Commands/UpdateUserCommand.js +41 -0
- package/dist/cjs/Commands/UploadImageCommand.js +17 -0
- package/dist/cjs/Commands/index.js +55 -0
- package/dist/cjs/Errors/AppError.js +8 -0
- package/dist/cjs/Errors/AuthenticationError.js +9 -0
- package/dist/cjs/Errors/AuthorizationError.js +9 -0
- package/dist/cjs/Errors/DeviceCommError.js +9 -0
- package/dist/cjs/Errors/LoginError.js +9 -0
- package/dist/cjs/Errors/NotFoundError.js +9 -0
- package/dist/cjs/Errors/RequestError.js +9 -0
- package/dist/cjs/Errors/SystemCommError.js +9 -0
- package/dist/cjs/Errors/TokenExpiredError.js +9 -0
- package/dist/cjs/Errors/UnprocessableRequestError.js +9 -0
- package/dist/cjs/Errors/ValidationError.js +9 -0
- package/dist/cjs/Errors/index.js +15 -0
- package/dist/cjs/Events/ApplicationInUseEvent.js +17 -0
- package/dist/cjs/Events/ApplicationOutOfUseEvent.js +17 -0
- package/dist/cjs/Events/EmailEvent.js +18 -0
- package/dist/cjs/Events/Event.js +55 -0
- package/dist/cjs/Events/SMSEvent.js +18 -0
- package/dist/cjs/Events/SMSSentEvent.js +17 -0
- package/dist/cjs/Events/ShortLinkCreatedEvent.js +17 -0
- package/dist/cjs/Events/SystemCameraUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemCourtesyUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemDimmerUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemGatewayUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemLockUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemMediaSourceUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemMotionSensorUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemProductUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemReservationUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemSceneControllerUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemSpaceTypeUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemSpaceUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemSwitchUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemThermostatUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemUserUpdatedEvent.js +17 -0
- package/dist/cjs/Events/SystemWindowCoveringUpdatedEvent.js +17 -0
- package/dist/cjs/Events/index.js +50 -0
- package/dist/cjs/Models/Alarm.js +29 -0
- package/dist/cjs/Models/Camera.js +29 -0
- package/dist/cjs/Models/Courtesy.js +33 -0
- package/dist/cjs/Models/Credential.js +29 -0
- package/dist/cjs/Models/Dimmer.js +61 -0
- package/dist/cjs/Models/DiscoveredDevice.js +30 -0
- package/dist/cjs/Models/EmailMessage.js +29 -0
- package/dist/cjs/Models/EnergyReport.js +29 -0
- package/dist/cjs/Models/EnergyReportShard.js +29 -0
- package/dist/cjs/Models/Gateway.js +29 -0
- package/dist/cjs/Models/Identification.js +32 -0
- package/dist/cjs/Models/Kohost.js +96 -0
- package/dist/cjs/Models/Lock.js +33 -0
- package/dist/cjs/Models/MediaFile.js +41 -0
- package/dist/cjs/Models/MediaSource.js +29 -0
- package/dist/cjs/Models/MotionSensor.js +29 -0
- package/dist/cjs/Models/Organization.js +28 -0
- package/dist/cjs/Models/Product.js +29 -0
- package/dist/cjs/Models/Property.js +28 -0
- package/dist/cjs/Models/Reservation.js +98 -0
- package/dist/cjs/Models/Room.js +212 -0
- package/dist/cjs/Models/Scene.js +183 -0
- package/dist/cjs/Models/ShortLink.js +29 -0
- package/dist/cjs/Models/SmsMessage.js +29 -0
- package/dist/cjs/Models/Space.js +97 -0
- package/dist/cjs/Models/SpaceType.js +30 -0
- package/dist/cjs/Models/Switch.js +33 -0
- package/dist/cjs/Models/SystemUser.js +48 -0
- package/dist/cjs/Models/Thermostat.js +80 -0
- package/dist/cjs/Models/Ticket.js +105 -0
- package/dist/cjs/Models/User.js +73 -0
- package/dist/cjs/Models/WindowCovering.js +49 -0
- package/dist/cjs/Models/index.js +68 -0
- package/dist/cjs/SocketIoClient/index.js +74 -0
- package/dist/cjs/defs/deviceTypes.js +15 -0
- package/dist/cjs/defs/formalDeviceTypes.js +6 -0
- package/dist/cjs/defs/index.js +11 -0
- package/dist/cjs/{index.cjs.js → index.js} +7 -1
- package/dist/cjs/schemas/alarm.json +103 -0
- package/dist/cjs/schemas/camera.json +50 -0
- package/dist/cjs/schemas/courtesy.json +46 -0
- package/dist/cjs/schemas/credential.json +31 -0
- package/dist/cjs/schemas/definitions.json +191 -0
- package/dist/cjs/schemas/dimmer.json +43 -0
- package/dist/cjs/schemas/discoveredDevice.json +31 -0
- package/dist/cjs/schemas/emailMessage.json +71 -0
- package/dist/cjs/schemas/energyReport.json +86 -0
- package/dist/cjs/schemas/energyReportShard.json +75 -0
- package/dist/cjs/schemas/gateway.json +35 -0
- package/dist/cjs/schemas/identification.json +61 -0
- package/dist/cjs/schemas/lock.json +45 -0
- package/dist/cjs/schemas/mediaFile.json +67 -0
- package/dist/cjs/schemas/mediaSource.json +184 -0
- package/dist/cjs/schemas/motionSensor.json +32 -0
- package/dist/cjs/schemas/organization.json +36 -0
- package/dist/cjs/schemas/payment.json +47 -0
- package/dist/cjs/schemas/product.json +40 -0
- package/dist/cjs/schemas/property.json +246 -0
- package/dist/cjs/schemas/reservation.json +118 -0
- package/dist/cjs/schemas/room.json +98 -0
- package/dist/cjs/schemas/scene.json +121 -0
- package/dist/cjs/schemas/shortLink.json +30 -0
- package/dist/cjs/schemas/smsMessage.json +61 -0
- package/dist/cjs/schemas/space.json +120 -0
- package/dist/cjs/schemas/spaceType.json +30 -0
- package/dist/cjs/schemas/switch.json +42 -0
- package/dist/cjs/schemas/systemUser.json +95 -0
- package/dist/cjs/schemas/thermostat.json +153 -0
- package/dist/cjs/schemas/ticket.json +96 -0
- package/dist/cjs/schemas/user.json +152 -0
- package/dist/cjs/schemas/windowCovering.json +43 -0
- package/dist/cjs/utils/errorFactory.js +8 -0
- package/dist/cjs/utils/eventFactory.js +10 -0
- package/dist/cjs/utils/getDeviceTypes.js +7 -0
- package/dist/cjs/utils/getFormalDeviceType.js +5 -0
- package/dist/cjs/utils/index.js +11 -0
- package/dist/cjs/utils/schema.js +25 -0
- package/dist/esm/Client.js +2293 -1205
- package/dist/esm/Client.js.map +4 -4
- package/dist/esm/Commands.js +478 -73
- package/dist/esm/Commands.js.map +3 -3
- package/dist/esm/Errors.js +35 -0
- package/dist/esm/Errors.js.map +1 -1
- package/dist/esm/Events.js +266 -63
- package/dist/esm/Events.js.map +3 -3
- package/dist/esm/Models.js +2853 -833
- package/dist/esm/Models.js.map +4 -4
- package/dist/esm/SocketIoClient.js +4748 -0
- package/dist/esm/SocketIoClient.js.map +7 -0
- package/dist/esm/defs.js +407 -279
- package/dist/esm/defs.js.map +4 -4
- package/dist/esm/index.js +17 -10
- package/dist/esm/utils.js +742 -85
- package/dist/esm/utils.js.map +3 -3
- package/dist/useCases/{AdminUpdateProperty.js → AdminUpdateCustomer.js} +2 -2
- package/dist/useCases/AssignSpaceToReservation.js +32 -0
- package/dist/useCases/BatchNotifyCheckIn.js +32 -0
- package/dist/useCases/CreateImageUploadEndpoint.js +32 -0
- package/dist/useCases/{CreateSource.js → CreateMediaSource.js} +2 -2
- package/dist/useCases/{AdminListCustomers.js → CreateOrganization.js} +3 -3
- package/dist/useCases/{LoginGateway.js → CreateProperty.js} +2 -2
- package/dist/useCases/{AdminCreateProperty.js → CreateSpaceType.js} +2 -2
- package/dist/useCases/DeleteMediaFile.js +32 -0
- package/dist/useCases/{DeleteSource.js → DeleteMediaSource.js} +2 -2
- package/dist/useCases/DeleteSpaceType.js +32 -0
- package/dist/useCases/DescribeLockCredential.js +32 -0
- package/dist/useCases/{DescribeIntegration.js → DescribeMediaSource.js} +3 -3
- package/dist/useCases/DescribeMyAccessCredentials.js +32 -0
- package/dist/useCases/{AdminDescribeProperty.js → DescribeOrganization.js} +2 -2
- package/dist/useCases/DescribeProduct.js +32 -0
- package/dist/useCases/{ListIntegrations.js → DescribeProperty.js} +3 -3
- package/dist/useCases/DescribeReservationEarlyCheckInProducts.js +32 -0
- package/dist/useCases/DescribeReservationRoomUpgrades.js +32 -0
- package/dist/useCases/{DeleteIntegration.js → DescribeSpaceType.js} +2 -2
- package/dist/useCases/ListMediaSources.js +32 -0
- package/dist/useCases/{AdminListProperties.js → ListMyTickets.js} +2 -2
- package/dist/useCases/{UpdateIntegration.js → ListOrganizations.js} +4 -4
- package/dist/useCases/ListProperties.js +32 -0
- package/dist/useCases/ListScenes.js +32 -0
- package/dist/useCases/ListSpaceTypes.js +32 -0
- package/dist/useCases/ListTeam.js +32 -0
- package/dist/useCases/ListUserSpaces.js +32 -0
- package/dist/useCases/LogoutUser.js +32 -0
- package/dist/useCases/PurchaseReservationEarlyCheckInProducts.js +32 -0
- package/dist/useCases/{CreateIntegrationDeviceMapEntry.js → PurchaseReservationRoomUpgrades.js} +2 -2
- package/dist/useCases/RequestLoginLink.js +1 -1
- package/dist/useCases/{CreateIntegration.js → RequestMyKeyToken.js} +2 -2
- package/dist/useCases/SendCheckInSMS.js +32 -0
- package/dist/useCases/{SetSource.js → SetDimmer.js} +2 -2
- package/dist/useCases/{DescribeSource.js → SetMediaSource.js} +3 -3
- package/dist/useCases/{UpdateSource.js → SetRoomScene.js} +3 -3
- package/dist/useCases/SetSpaceScene.js +32 -0
- package/dist/useCases/UpdateMediaSource.js +32 -0
- package/dist/useCases/UpdateProperty.js +32 -0
- package/dist/useCases/UpdateSpaceType.js +32 -0
- package/dist/useCases/{ListSources.js → UploadImage.js} +4 -4
- package/package.json +25 -10
- package/dist/cjs/Commands.js +0 -568
- package/dist/cjs/Errors.js +0 -174
- package/dist/cjs/Events.js +0 -375
- package/dist/cjs/Models.js +0 -3582
- package/dist/cjs/defs.js +0 -175
- package/dist/cjs/utils.js +0 -246
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema",
|
|
3
|
+
"$id": "windowCovering.json",
|
|
4
|
+
"title": "Window Covering",
|
|
5
|
+
"description": "Any smart window covering",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"properties": {
|
|
8
|
+
"id": {
|
|
9
|
+
"$ref": "definitions.json#/definitions/id"
|
|
10
|
+
},
|
|
11
|
+
"name": {
|
|
12
|
+
"type": "string"
|
|
13
|
+
},
|
|
14
|
+
"type": {
|
|
15
|
+
"$ref": "definitions.json#/definitions/type"
|
|
16
|
+
},
|
|
17
|
+
"subType": {
|
|
18
|
+
"$ref": "definitions.json#/definitions/subType"
|
|
19
|
+
},
|
|
20
|
+
"supportedNotifications": {
|
|
21
|
+
"$ref": "definitions.json#/definitions/supportedNotifications"
|
|
22
|
+
},
|
|
23
|
+
"notification": {
|
|
24
|
+
"$ref": "definitions.json#/definitions/notification"
|
|
25
|
+
},
|
|
26
|
+
"driver": {
|
|
27
|
+
"$ref": "definitions.json#/definitions/driver"
|
|
28
|
+
},
|
|
29
|
+
"position": {
|
|
30
|
+
"type": "number",
|
|
31
|
+
"minimum": 0,
|
|
32
|
+
"maximum": 100
|
|
33
|
+
},
|
|
34
|
+
"systemData": {
|
|
35
|
+
"$ref": "definitions.json#/definitions/systemData"
|
|
36
|
+
},
|
|
37
|
+
"watts": {
|
|
38
|
+
"$ref": "definitions.json#/definitions/watts"
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
"additionalProperties": false,
|
|
42
|
+
"required": ["id", "type", "systemData", "position", "driver"]
|
|
43
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
const Errors = require("../Errors");
|
|
2
|
+
|
|
3
|
+
module.exports = function errorFactory(errName) {
|
|
4
|
+
const AllErrors = Object.values(Errors);
|
|
5
|
+
const TheError = AllErrors.find((E) => E.prototype.name === errName);
|
|
6
|
+
if (!TheError) return new Error("Invalid error name: " + errName);
|
|
7
|
+
return TheError;
|
|
8
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
const Events = require("../Events");
|
|
2
|
+
|
|
3
|
+
function eventFactory(eventName) {
|
|
4
|
+
const AllEvents = Object.values(Events);
|
|
5
|
+
const Event = AllEvents.find((E) => E.prototype.name === eventName);
|
|
6
|
+
if (!Event) throw new Error("Invalid event name: " + eventName);
|
|
7
|
+
return Event;
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
module.exports = eventFactory;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
const getFormalDeviceType = require("./getFormalDeviceType");
|
|
2
|
+
const getDeviceTypes = require("./getDeviceTypes");
|
|
3
|
+
const schema = require("./schema");
|
|
4
|
+
const errorFactory = require("./errorFactory");
|
|
5
|
+
|
|
6
|
+
module.exports = {
|
|
7
|
+
getFormalDeviceType: getFormalDeviceType,
|
|
8
|
+
getDeviceTypes: getDeviceTypes,
|
|
9
|
+
schema: schema,
|
|
10
|
+
errorFactory: errorFactory,
|
|
11
|
+
};
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
const Ajv = require("ajv");
|
|
2
|
+
const ajv = new Ajv({
|
|
3
|
+
allErrors: true,
|
|
4
|
+
useDefaults: true,
|
|
5
|
+
strict: false,
|
|
6
|
+
allowMatchingProperties: true,
|
|
7
|
+
allowUnionTypes: true,
|
|
8
|
+
strictRequired: false,
|
|
9
|
+
});
|
|
10
|
+
const addFormats = require("ajv-formats");
|
|
11
|
+
|
|
12
|
+
const defininitions = require("../schemas/definitions.json");
|
|
13
|
+
|
|
14
|
+
addFormats(ajv);
|
|
15
|
+
|
|
16
|
+
ajv.addSchema(defininitions);
|
|
17
|
+
|
|
18
|
+
module.exports = {
|
|
19
|
+
add: function add(schema) {
|
|
20
|
+
ajv.addSchema(schema);
|
|
21
|
+
},
|
|
22
|
+
compile: function compile(schema) {
|
|
23
|
+
return ajv.compile(schema);
|
|
24
|
+
},
|
|
25
|
+
};
|