{ "host": "api.athom.com", "basePath": "/", "operations": { "createDelegationToken": { "path": "/delegation/token", "method": "post", "private": true, "parameters": { "audience": { "in": "query", "type": "string" }, "meta": { "in": "body", "type": "object", "unpack": true } } }, "verifyDelegationToken": { "path": "/delegation/verify", "method": "get", "private": true, "parameters": { "token": { "in": "query", "type": "string" } } }, "getDelegationTokenKey": { "path": "/delegation/key", "method": "get", "private": true, "parameters": {} }, "getAccessToken": { "path": "/oauth2/token", "method": "post", "private": true, "parameters": { "client_id": { "in": "formData", "type": "string", "required": true }, "client_secret": { "in": "formData", "type": "string", "required": true }, "grant_type": { "in": "formData", "type": "string", "required": true }, "refresh_token": { "in": "formData", "type": "string" }, "code": { "in": "formData", "type": "string" }, "username": { "in": "formData", "type": "string" }, "password": { "in": "formData", "type": "string" } } }, "forgotPassword": { "path": "/login/password-forgotten", "method": "post", "private": true, "parameters": { "email": { "type": "string", "in": "body" } } }, "createUser": { "path": "/user", "method": "post", "private": true, "parameters": { "user": { "in": "body", "type": "object", "required": true, "unpack": true, "properties": { "firstname": { "type": "string" }, "lastname": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "language": { "type": "string" } } }, "newsletter": { "in": "query", "type": "boolean" }, "gettingStarted": { "in": "query", "type": "boolean" } } }, "getUser": { "path": "/user/{id}", "method": "get", "private": true, "parameters": { "id": { "in": "path", "type": "string", "required": true } } }, "updateUser": { "path": "/user/{id}", "method": "put", "private": true, "parameters": { "id": { "in": "path", "type": "string", "required": true }, "user": { "in": "body", "type": "object", "required": true, "unpack": true, "properties": { "firstname": { "type": "string" }, "lastname": { "type": "string" }, "email": { "type": "string" }, "language": { "type": "string" }, "roles": { "type": "array" }, "roleIds": { "type": "array" }, "avatar": {}, "homeys": { "type": "array" }, "devices": { "type": "array" } } } } }, "deleteUser": { "path": "/user/{id}", "method": "delete", "private": true, "parameters": { "id": { "in": "path", "type": "string", "required": true }, "password": { "type": "string", "in": "body" } } }, "createUserDevice": { "path": "/user/{userId}/device", "method": "post", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true }, "device": { "in": "body", "type": "object", "required": true, "unpack": true, "properties": { "name": { "type": "string" }, "platform": { "type": "string" }, "token": { "type": "string" }, "publicKey": { "type": "string" }, "appVersion": { "type": "string" }, "osVersion": { "type": "string" }, "created": { "type": "string" }, "updated": { "type": "string" }, "devmode": { "type": "boolean" } } } } }, "updateUserDevice": { "path": "/user/{userId}/device/{deviceId}", "method": "put", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true }, "deviceId": { "in": "path", "type": "string", "required": true }, "device": { "in": "body", "type": "object", "required": true, "unpack": true, "properties": { "name": { "type": "string" }, "platform": { "type": "string" }, "token": { "type": "string" }, "publicKey": { "type": "string" }, "appVersion": { "type": "string" }, "osVersion": { "type": "string" }, "created": { "type": "string" }, "updated": { "type": "string" }, "devmode": { "type": "boolean" } } } } }, "deleteUserDevice": { "path": "/user/{userId}/device/{deviceId}", "method": "delete", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true }, "deviceId": { "in": "path", "type": "string", "required": true } } }, "getUserAddresses": { "path": "/user/{userId}/address", "method": "get", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true } } }, "addUserAddress": { "path": "/user/{userId}/address", "method": "post", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true }, "address": { "in": "body", "type": "object", "unpack": true, "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "extra": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" } } } } }, "updateUserAddress": { "path": "/user/{userId}/address/{addressId}", "method": "put", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true }, "addressId": { "in": "path", "type": "string", "required": true }, "address": { "in": "body", "type": "object", "unpack": true, "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "extra": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" } } } } }, "deleteUserAddress": { "path": "/user/{userId}/address/{addressId}", "method": "delete", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true }, "addressId": { "in": "path", "type": "string", "required": true } } }, "updateUserSubscription": { "path": "/user/{userId}/subscription/{subscriptionId}", "method": "put", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true }, "subscriptionId": { "in": "path", "type": "string", "required": true }, "subscription": { "in": "body" } } }, "deleteUserSubscription": { "path": "/user/{userId}/subscription/{subscriptionId}", "method": "delete", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true }, "subscriptionId": { "in": "path", "type": "string", "required": true } } }, "addRoleAppDeveloperTrusted": { "path": "/user/{userId}/role/app_developer_trusted", "method": "put", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true } } }, "removeRoleAppDeveloperTrusted": { "path": "/user/{userId}/role/app_developer_trusted", "method": "delete", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true } } }, "addRoleCertifiedInstaller": { "path": "/user/{userId}/role/installer", "method": "put", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true } } }, "getAuthenticatedUser": { "path": "/user/me", "method": "get", "parameters": { "additionalScopes": { "in": "query", "type": "string" } } }, "getAcceptedInvites": { "path": "/user/me/accepted_invites", "method": "get", "private": true, "parameters": {} }, "getPersonalAccessTokenApps": { "path": "/user/me/pat/apps", "method": "get", "private": true, "parameters": {} }, "deletePersonalAccessTokenApps": { "path": "/user/me/pat/apps", "method": "delete", "private": true, "parameters": {} }, "updateAuthenticatedUserPassword": { "path": "/user/me/password", "method": "post", "private": true, "parameters": { "password": { "type": "string", "in": "body" }, "old_password": { "type": "string", "in": "body" } } }, "getUserProfile": { "path": "/user/{userId}/profile", "method": "get", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true } } }, "getUserSessions": { "path": "/user/{userId}/session", "method": "get", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true } } }, "deleteUserSession": { "path": "/user/{userId}/session/{sessionId}", "method": "delete", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true }, "sessionId": { "in": "path", "type": "string", "required": true } } }, "acceptInvite": { "path": "/user/{userId}/accept_invite/{inviterId}", "method": "post", "private": true, "parameters": { "userId": { "in": "path", "type": "string", "required": true }, "inviterId": { "in": "path", "type": "string", "required": true } } }, "getAuthenticatedUserNewsletterStatus": { "path": "/user/me/newsletter", "method": "get", "parameters": {} }, "subscribeAuthenticatedUserToNewsletter": { "path": "/user/me/newsletter", "method": "post", "parameters": { "language": { "type": "string", "in": "body" } } }, "unsubscribeAuthenticatedUserFromNewsletter": { "path": "/user/me/newsletter", "method": "delete", "parameters": {} }, "getInstallerInformation": { "path": "/user/{userId}/installer-information", "method": "get", "parameters": { "userId": { "in": "path", "type": "string", "required": true } } }, "updateInstallerInformation": { "path": "/user/{userId}/installer-information", "method": "put", "parameters": { "userId": { "in": "path", "type": "string", "required": true }, "website": { "type": "string", "in": "body" }, "email": { "type": "string", "in": "body" }, "phone": { "type": "string", "in": "body" } } }, "getAuthenticatedUserClients": { "path": "/user/me/client", "method": "get", "parameters": {} }, "createAuthenticatedUserClient": { "path": "/user/me/client", "method": "post", "parameters": { "name": { "type": "string", "in": "body" }, "redirectUri": { "type": "array", "in": "body" }, "scopes": { "type": "array", "in": "body" } } }, "updateAuthenticatedUserClient": { "path": "/user/me/client/{id}", "method": "put", "parameters": { "id": { "in": "path", "type": "string", "required": true }, "name": { "type": "string", "in": "body" }, "redirectUri": { "type": "array", "in": "body" }, "scopes": { "type": "array", "in": "body" } } }, "deleteAuthenticatedUserClient": { "path": "/user/me/client/{id}", "method": "delete", "parameters": { "id": { "in": "path", "type": "string", "required": true } } }, "getBridges": { "path": "/bridge/", "method": "get", "private": true, "parameters": { "serial": { "in": "query", "type": "string" }, "serialHash": { "in": "query", "type": "string" } } }, "createBridge": { "path": "/bridge/", "method": "post", "private": true, "parameters": { "bridge": { "in": "body", "type": "object", "unpack": true, "properties": { "serial": { "type": "string" }, "build": { "type": "number" }, "zwaveCalibration": { "type": "array" }, "manufacturedAt": { "type": "string" }, "activationHistory": { "type": "array" }, "model": { "type": "string" } } } } }, "getBridge": { "path": "/bridge/{serial}", "method": "get", "private": true, "parameters": { "serial": { "in": "path", "type": "string", "required": true } } }, "updateBridge": { "path": "/bridge/{serial}", "method": "put", "private": true, "parameters": { "serial": { "in": "path", "type": "string", "required": true }, "bridge": { "in": "body", "type": "object", "unpack": true, "properties": { "serial": { "type": "string" }, "build": { "type": "number" }, "zwaveCalibration": { "type": "array" }, "manufacturedAt": { "type": "string" }, "activationHistory": { "type": "array" }, "model": { "type": "string" } } } } }, "activateBridge": { "path": "/bridge/{serial}/activate", "method": "post", "private": true, "parameters": { "serial": { "in": "path", "type": "string", "required": true }, "homeyId": { "type": "string", "in": "body" }, "userId": { "type": "string", "in": "body" } } }, "getHomeys": { "path": "/homey/", "method": "get", "private": true, "parameters": { "serial": { "in": "query", "type": "string" }, "softwareVersion": { "in": "query", "type": "string" }, "search": { "in": "query", "type": "string" }, "page": { "in": "query", "type": "string" } } }, "createHomey": { "path": "/homey/", "method": "post", "private": true, "parameters": { "data": { "in": "body", "type": "object", "unpack": true, "properties": { "name": { "type": "string" }, "ipInternal": { "type": "string" }, "ipExternal": { "type": "string" }, "ipExternalCountry": { "type": "string" }, "ipExternalPort": { "type": "number" }, "localUrl": { "type": "string" }, "localUrlSecure": { "type": "string" }, "remoteUrl": { "type": "string" }, "apiVersion": { "type": "number" }, "softwareVersion": { "type": "string" }, "language": { "type": "string" }, "state": { "type": "string" }, "geolocation": { "type": "object" }, "users": { "type": "array" }, "role": { "type": "string" }, "token": { "type": "string" }, "apps": { "type": "array" }, "devices": { "type": "array" }, "eMMCestLifeTimeA": { "type": "number" }, "eMMCestLifeTimeB": { "type": "number" }, "eMMCpreEOLInfo": { "type": "number" } } } } }, "getHomey": { "path": "/homey/{id}", "method": "get", "private": true, "parameters": { "id": { "in": "path", "type": "string", "required": true } } }, "updateHomey": { "path": "/homey/{id}", "method": "put", "private": true, "parameters": { "id": { "in": "path", "type": "string", "required": true }, "homey": { "in": "body", "type": "object", "required": true, "unpack": true, "properties": { "name": { "type": "string" }, "ipInternal": { "type": "string" }, "ipExternal": { "type": "string" }, "ipExternalCountry": { "type": "string" }, "ipExternalPort": { "type": "number" }, "localUrl": { "type": "string" }, "localUrlSecure": { "type": "string" }, "remoteUrl": { "type": "string" }, "apiVersion": { "type": "number" }, "softwareVersion": { "type": "string" }, "language": { "type": "string" }, "state": { "type": "string" }, "geolocation": { "type": "object" }, "users": { "type": "array" }, "role": { "type": "string" }, "token": { "type": "string" }, "apps": { "type": "array" }, "devices": { "type": "array" }, "eMMCestLifeTimeA": { "type": "number" }, "eMMCestLifeTimeB": { "type": "number" }, "eMMCpreEOLInfo": { "type": "number" } } } } }, "deleteHomey": { "path": "/homey/{id}", "method": "delete", "private": true, "parameters": { "id": { "in": "path", "type": "string", "required": true } } }, "activateHomey": { "path": "/homey/{id}/activate", "method": "post", "private": true, "parameters": { "id": { "in": "path", "type": "string", "required": true }, "userId": { "type": "string", "in": "body" } } }, "addHomeyLicense": { "path": "/homey/{homeyId}/license/{license}", "method": "post", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true }, "license": { "in": "path", "type": "string", "required": true } } }, "createHomeyUser": { "path": "/homey/{homeyId}/user", "method": "post", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true }, "user": { "type": "string", "in": "body" }, "role": { "type": "string", "in": "body" }, "token": { "type": "string", "in": "body" } } }, "deleteHomeyUser": { "path": "/homey/{homeyId}/user/{userId}", "method": "delete", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true }, "userId": { "in": "path", "type": "string", "required": true } } }, "resetHomeyUsers": { "path": "/homey/{homeyId}/user/reset", "method": "post", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true } } }, "getAllHomeyMetadata": { "path": "/homey/{homeyId}/metadata", "method": "get", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true } } }, "getHomeyMetadata": { "path": "/homey/{homeyId}/metadata/{key}", "method": "get", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true }, "key": { "in": "path", "type": "string", "required": true } } }, "createHomeyMetadata": { "path": "/homey/{homeyId}/metadata/{key}", "method": "post", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true }, "key": { "in": "path", "type": "string", "required": true }, "value": { "type": "object", "in": "body" } } }, "updateHomeyMetadata": { "path": "/homey/{homeyId}/metadata/{key}", "method": "put", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true }, "key": { "in": "path", "type": "string", "required": true }, "value": { "type": "object", "in": "body" } } }, "deleteHomeyMetadata": { "path": "/homey/{homeyId}/metadata/{key}", "method": "delete", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true }, "key": { "in": "path", "type": "string", "required": true } } }, "updateHomeySendConnectionNotifications": { "path": "/homey/{homeyId}/send-connection-notifications", "method": "put", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true }, "push": { "type": "boolean", "in": "body" }, "email": { "type": "boolean", "in": "body" } } }, "createHomeySelfHostedServer": { "path": "/homey/shs", "method": "post", "private": true, "parameters": {} }, "deleteHomeySelfHostedServer": { "path": "/homey/shs/{homeyId}", "method": "delete", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true } } }, "updateHomeySelfHostedServerSubscription": { "path": "/homey/shs/{homeyId}/subscription", "method": "put", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true }, "type": { "type": "string", "in": "body" }, "expiresAt": { "type": "string", "in": "body" }, "shopifyContractId": { "type": "string", "in": "body" } } }, "transferHomeySelfHostedServerLifetimeLicense": { "path": "/homey/shs/{homeyId}/transfer-lifetime-license", "method": "post", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true }, "newHomeyId": { "type": "string", "in": "body" } } }, "updateHomeySelfHostedServerCustomHostname": { "path": "/homey/shs/{homeyId}/custom-hostname", "method": "put", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true }, "customHostname": { "type": "string", "in": "body" } } }, "deleteHomeySelfHostedServerCustomHostname": { "path": "/homey/shs/{homeyId}/custom-hostname", "method": "delete", "private": true, "parameters": { "homeyId": { "in": "path", "type": "string", "required": true } } }, "expireSelfHostedServerSubscriptions": { "path": "/homey/shs/cron/expire-subscriptions", "method": "post", "private": true, "parameters": {} }, "sendFormattedEmail": { "path": "/mail/formatted", "method": "post", "private": true, "parameters": { "to": { "type": "string", "in": "body" }, "toHomeyOwner": { "type": "string", "in": "body" }, "from": { "type": "string", "in": "body" }, "subject": { "type": "string", "in": "body" }, "body": { "type": "string", "in": "body" }, "replyTo": { "type": "string", "in": "body" }, "logo": { "type": "object", "in": "body" }, "header": { "type": "object", "in": "body" }, "button": { "type": "object", "in": "body" } } }, "subscribeUserToMailChimp": { "path": "/mail/mailchimp", "method": "post", "private": true, "parameters": { "listId": { "type": "string", "in": "body" }, "userId": { "type": "string", "in": "body" }, "tags": { "type": "array", "in": "body" } } }, "upsertUserToMailChimp": { "path": "/mail/mailchimp", "method": "put", "private": true, "parameters": { "listId": { "type": "string", "in": "body" }, "userId": { "type": "string", "in": "body" }, "tags": { "type": "array", "in": "body" } } }, "addTagToMailChimpUser": { "path": "/mail/mailchimp/tag", "method": "post", "private": true, "parameters": { "listId": { "type": "string", "in": "body" }, "userId": { "type": "string", "in": "body" }, "tag": { "type": "string", "in": "body" } } }, "removeTagFromMailChimpUser": { "path": "/mail/mailchimp/tag/{tag}/list/{listId}/user/{userId}", "method": "delete", "private": true, "parameters": { "tag": { "in": "path", "type": "string", "required": true }, "listId": { "in": "path", "type": "string", "required": true }, "userId": { "in": "path", "type": "string", "required": true } } }, "getPortals": { "path": "/portal/", "method": "get", "private": true, "parameters": { "serial": { "in": "query", "type": "string" } } }, "createPortal": { "path": "/portal/", "method": "post", "private": true, "parameters": { "portal": { "in": "body", "type": "object", "unpack": true, "properties": { "serial": { "type": "string" }, "build": { "type": "number" }, "manufacturedAt": { "type": "string" }, "activationHistory": { "type": "array" }, "model": { "type": "string" } } } } }, "getPortal": { "path": "/portal/{serial}", "method": "get", "private": true, "parameters": { "serial": { "in": "path", "type": "string", "required": true } } }, "updatePortal": { "path": "/portal/{serial}", "method": "put", "private": true, "parameters": { "serial": { "in": "path", "type": "string", "required": true }, "portal": { "in": "body", "type": "object", "unpack": true, "properties": { "serial": { "type": "string" }, "build": { "type": "number" }, "manufacturedAt": { "type": "string" }, "activationHistory": { "type": "array" }, "model": { "type": "string" } } } } }, "activatePortal": { "path": "/portal/{serial}/activate", "method": "post", "private": true, "parameters": { "serial": { "in": "path", "type": "string", "required": true }, "homeyId": { "type": "string", "in": "body" }, "userId": { "type": "string", "in": "body" } } }, "getAppInstallsStatistics": { "path": "/stats/app-installs", "method": "get", "private": true, "parameters": {} }, "getAppDriversStatistics": { "path": "/stats/app-drivers", "method": "get", "private": true, "parameters": {} }, "getLocationStatistics": { "path": "/stats/locations", "method": "get", "private": true, "parameters": { "since": { "in": "query", "type": "number" } } }, "getVersionStatistics": { "path": "/stats/homey-software-versions", "method": "get", "private": true, "parameters": {} }, "getProductionStatistics": { "path": "/stats/homey-production-speed", "method": "get", "private": true, "parameters": { "min": { "in": "query", "type": "string" }, "max": { "in": "query", "type": "string" } } }, "getHomeyOwnerContactDetails": { "path": "/stats/homey-owner-data", "method": "get", "private": true, "parameters": { "softwareVersion": { "in": "query", "type": "string" }, "homeyId": { "in": "query", "type": "string" }, "homeySn": { "in": "query", "type": "string" }, "barcodeMin": { "in": "query", "type": "string" }, "barcodeMax": { "in": "query", "type": "string" }, "appId": { "in": "query", "type": "string" }, "appChannel": { "in": "query", "type": "string" }, "appVersion": { "in": "query", "type": "string" }, "page": { "in": "query", "type": "number" } } } } }