From 043c396d367981b8ba9621a10d5f0d3407d34272 Mon Sep 17 00:00:00 2001 From: Jamie D Date: Mon, 31 Jan 2022 20:42:37 +0000 Subject: [PATCH] Regenerated api 31/01/2022 --- GitVersion.yml | 2 +- LICENSE.txt | 2 +- docs/Action.md | 13 - docs/AdhocMessage.md | 12 - docs/AdhocMessageTemplate.md | 12 - docs/App.md | 24 - docs/AppClassification.md | 9 - docs/AppDeviceDetails.md | 11 - docs/AppOAuth.md | 11 - docs/AppTargetStatus.md | 9 - docs/AppType.md | 9 - docs/AppUISettings.md | 13 - docs/AppsApi.md | 996 ------------------- docs/Argument.md | 11 - docs/ArrayOperand.md | 10 - docs/AttributeProperties.md | 11 - docs/AttributePropertiesData.md | 12 - docs/AttributePropertiesUnit.md | 11 - docs/AttributeSchema.md | 14 - docs/AttributeState.md | 12 - docs/BetweenCondition.md | 13 - docs/CapabilityAttribute.md | 11 - docs/CapabilityAttributeEnumCommands.md | 10 - docs/CapabilityCommand.md | 10 - docs/CapabilityReference.md | 10 - docs/CapabilitySubscriptionDetail.md | 16 - docs/CapabilitySummary.md | 11 - docs/ChangesCondition.md | 11 - docs/CommandAction.md | 11 - docs/ComponentTranslations.md | 11 - docs/Condition.md | 18 - docs/ConditionAggregationMode.md | 8 - docs/ConfigEntry.md | 16 - docs/CreateAppRequest.md | 20 - docs/CreateAppResponse.md | 12 - docs/CreateDeviceProfileRequest.md | 11 - docs/CreateInstalledAppEventsRequest.md | 10 - docs/CreateLocationRequest.md | 16 - docs/CreateOrUpdateLambdaSmartAppRequest.md | 10 - docs/CreateOrUpdateWebhookSmartAppRequest.md | 10 - docs/CreateRoomRequest.md | 9 - docs/CronSchedule.md | 10 - docs/DashboardCardLifecycle.md | 8 - docs/DateOperand.md | 13 - docs/DateTimeOperand.md | 15 - docs/DayOfWeek.md | 8 - docs/DeleteInstalledAppResponse.md | 10 - docs/Device.md | 26 - docs/DeviceActivity.md | 21 - docs/DeviceCategory.md | 10 - docs/DeviceCommand.md | 12 - docs/DeviceCommandsEvent.md | 14 - docs/DeviceCommandsEventCommand.md | 12 - docs/DeviceCommandsRequest.md | 9 - docs/DeviceComponent.md | 11 - docs/DeviceComponentReference.md | 11 - docs/DeviceConfig.md | 12 - docs/DeviceEvent.md | 20 - docs/DeviceEventsRequest.md | 9 - docs/DeviceHealthDetail.md | 12 - docs/DeviceHealthEvent.md | 15 - docs/DeviceInstallRequest.md | 11 - docs/DeviceInstallRequestApp.md | 11 - docs/DeviceIntegrationType.md | 9 - docs/DeviceLifecycle.md | 9 - docs/DeviceLifecycleDetail.md | 12 - docs/DeviceLifecycleEvent.md | 20 - docs/DeviceLifecycleMove.md | 10 - docs/DeviceNetworkSecurityLevel.md | 9 - docs/DeviceOperand.md | 15 - docs/DeviceProfile.md | 14 - docs/DeviceProfileReference.md | 9 - docs/DeviceProfileStatus.md | 9 - docs/DeviceResults.md | 10 - docs/DeviceStateEvent.md | 14 - docs/DeviceStatus.md | 10 - docs/DeviceSubscriptionDetail.md | 17 - docs/DeviceprofilesApi.md | 428 -------- docs/DevicesApi.md | 840 ---------------- docs/DthDeviceDetails.md | 14 - docs/EndpointApp.md | 28 - docs/EqualsCondition.md | 12 - docs/Error.md | 13 - docs/ErrorResponse.md | 10 - docs/EventType.md | 9 - docs/EveryAction.md | 12 - docs/ExecutionResult.md | 8 - docs/GenerateAppOAuthRequest.md | 10 - docs/GenerateAppOAuthResponse.md | 12 - docs/GetAppSettingsResponse.md | 10 - docs/GreaterThanCondition.md | 12 - docs/GreaterThanOrEqualsCondition.md | 12 - docs/HubHealthDetail.md | 11 - docs/HubHealthEvent.md | 14 - docs/IconImage.md | 10 - docs/IfAction.md | 22 - docs/IfActionAllOf.md | 12 - docs/InstallConfiguration.md | 14 - docs/InstallConfigurationDetail.md | 15 - docs/InstallConfigurationStatus.md | 9 - docs/InstalledApp.md | 24 - docs/InstalledAppIconImage.md | 10 - docs/InstalledAppLifecycle.md | 9 - docs/InstalledAppLifecycleError.md | 12 - docs/InstalledAppLifecycleEvent.md | 20 - docs/InstalledAppStatus.md | 9 - docs/InstalledAppType.md | 9 - docs/InstalledAppUi.md | 13 - docs/InstalledappsApi.md | 512 ---------- docs/Interval.md | 10 - docs/IntervalUnit.md | 8 - docs/IrDeviceDetails.md | 15 - docs/IrDeviceDetailsFunctionCodes.md | 10 - docs/IsaResults.md | 15 - docs/LambdaSmartApp.md | 10 - docs/LessThanCondition.md | 12 - docs/LessThanOrEqualsCondition.md | 12 - docs/Link.md | 9 - docs/Links.md | 10 - docs/LocaleReference.md | 9 - docs/LocaleVariables.md | 11 - docs/Location.md | 19 - docs/LocationAction.md | 10 - docs/LocationAttribute.md | 8 - docs/LocationOperand.md | 10 - docs/LocationsApi.md | 414 -------- docs/Message.md | 11 - docs/MessageConfig.md | 10 - docs/MessageTemplate.md | 11 - docs/MessageType.md | 9 - docs/Mode.md | 11 - docs/ModeConfig.md | 10 - docs/ModeEvent.md | 11 - docs/ModeSubscriptionDetail.md | 10 - docs/Notice.md | 12 - docs/NoticeAction.md | 9 - docs/NoticeCode.md | 9 - docs/OnceSchedule.md | 10 - docs/Operand.md | 19 - docs/OperandAggregationMode.md | 8 - docs/Owner.md | 11 - docs/PagedApp.md | 18 - docs/PagedApps.md | 11 - docs/PagedDeviceProfiles.md | 10 - docs/PagedDevices.md | 11 - docs/PagedInstallConfigurations.md | 11 - docs/PagedInstalledApps.md | 11 - docs/PagedLocation.md | 11 - docs/PagedLocations.md | 11 - docs/PagedMessageTemplate.md | 11 - docs/PagedRooms.md | 11 - docs/PagedRules.md | 11 - docs/PagedSchedules.md | 11 - docs/PagedSubscriptions.md | 11 - docs/ParentType.md | 9 - docs/PermissionConfig.md | 10 - docs/PredefinedMessage.md | 12 - docs/PrincipalType.md | 9 - docs/Room.md | 12 - docs/RoomsApi.md | 424 -------- docs/Rule.md | 12 - docs/RuleAllOf.md | 9 - docs/RuleExecutionResponse.md | 11 - docs/RuleMetadata.md | 19 - docs/RuleRequest.md | 11 - docs/RulesApi.md | 499 ---------- docs/SceneAction.md | 13 - docs/SceneArgument.md | 12 - docs/SceneCapability.md | 12 - docs/SceneCommand.md | 10 - docs/SceneComponent.md | 11 - docs/SceneConfig.md | 11 - docs/SceneDevice.md | 14 - docs/SceneDeviceGroup.md | 10 - docs/SceneDeviceGroupRequest.md | 12 - docs/SceneDeviceRequest.md | 12 - docs/SceneLifecycle.md | 9 - docs/SceneLifecycleDetail.md | 11 - docs/SceneLifecycleEvent.md | 16 - docs/SceneMode.md | 11 - docs/SceneModeRequest.md | 12 - docs/ScenePagedResult.md | 10 - docs/SceneRequest.md | 17 - docs/SceneSecurityModeRequest.md | 12 - docs/SceneSleepRequest.md | 10 - docs/SceneSummary.md | 19 - docs/ScenesApi.md | 170 ---- docs/Schedule.md | 13 - docs/ScheduleRequest.md | 11 - docs/SchedulesApi.md | 420 -------- docs/SecurityArmStateDetail.md | 11 - docs/SecurityArmStateEvent.md | 13 - docs/SignatureType.md | 9 - docs/SimpleCondition.md | 12 - docs/SimpleValue.md | 14 - docs/SingleOperandCondition.md | 11 - docs/SleepAction.md | 10 - docs/SmartAppDashboardCardEventRequest.md | 11 - docs/SmartAppEventRequest.md | 10 - docs/StandardSuccessResponse.md | 10 - docs/StringConfig.md | 10 - docs/Subscription.md | 19 - docs/SubscriptionDelete.md | 10 - docs/SubscriptionFilter.md | 14 - docs/SubscriptionFilterTypes.md | 9 - docs/SubscriptionMode.md | 8 - docs/SubscriptionRequest.md | 17 - docs/SubscriptionSource.md | 9 - docs/SubscriptionTarget.md | 9 - docs/SubscriptionsApi.md | 413 -------- docs/TimeOperand.md | 11 - docs/TimeReference.md | 8 - docs/TimerEvent.md | 14 - docs/TimerType.md | 9 - docs/UpdateAppOAuthRequest.md | 11 - docs/UpdateAppRequest.md | 17 - docs/UpdateAppSettingsRequest.md | 10 - docs/UpdateAppSettingsResponse.md | 10 - docs/UpdateDeviceProfileRequest.md | 10 - docs/UpdateDeviceRequest.md | 10 - docs/UpdateDeviceRequestComponents.md | 10 - docs/UpdateLocationRequest.md | 15 - docs/UpdateRoomRequest.md | 9 - docs/UpdateSignatureTypeRequest.md | 10 - docs/ViperDeviceDetails.md | 13 - docs/WebhookSmartApp.md | 13 - 226 files changed, 2 insertions(+), 7664 deletions(-) delete mode 100644 docs/Action.md delete mode 100644 docs/AdhocMessage.md delete mode 100644 docs/AdhocMessageTemplate.md delete mode 100644 docs/App.md delete mode 100644 docs/AppClassification.md delete mode 100644 docs/AppDeviceDetails.md delete mode 100644 docs/AppOAuth.md delete mode 100644 docs/AppTargetStatus.md delete mode 100644 docs/AppType.md delete mode 100644 docs/AppUISettings.md delete mode 100644 docs/AppsApi.md delete mode 100644 docs/Argument.md delete mode 100644 docs/ArrayOperand.md delete mode 100644 docs/AttributeProperties.md delete mode 100644 docs/AttributePropertiesData.md delete mode 100644 docs/AttributePropertiesUnit.md delete mode 100644 docs/AttributeSchema.md delete mode 100644 docs/AttributeState.md delete mode 100644 docs/BetweenCondition.md delete mode 100644 docs/CapabilityAttribute.md delete mode 100644 docs/CapabilityAttributeEnumCommands.md delete mode 100644 docs/CapabilityCommand.md delete mode 100644 docs/CapabilityReference.md delete mode 100644 docs/CapabilitySubscriptionDetail.md delete mode 100644 docs/CapabilitySummary.md delete mode 100644 docs/ChangesCondition.md delete mode 100644 docs/CommandAction.md delete mode 100644 docs/ComponentTranslations.md delete mode 100644 docs/Condition.md delete mode 100644 docs/ConditionAggregationMode.md delete mode 100644 docs/ConfigEntry.md delete mode 100644 docs/CreateAppRequest.md delete mode 100644 docs/CreateAppResponse.md delete mode 100644 docs/CreateDeviceProfileRequest.md delete mode 100644 docs/CreateInstalledAppEventsRequest.md delete mode 100644 docs/CreateLocationRequest.md delete mode 100644 docs/CreateOrUpdateLambdaSmartAppRequest.md delete mode 100644 docs/CreateOrUpdateWebhookSmartAppRequest.md delete mode 100644 docs/CreateRoomRequest.md delete mode 100644 docs/CronSchedule.md delete mode 100644 docs/DashboardCardLifecycle.md delete mode 100644 docs/DateOperand.md delete mode 100644 docs/DateTimeOperand.md delete mode 100644 docs/DayOfWeek.md delete mode 100644 docs/DeleteInstalledAppResponse.md delete mode 100644 docs/Device.md delete mode 100644 docs/DeviceActivity.md delete mode 100644 docs/DeviceCategory.md delete mode 100644 docs/DeviceCommand.md delete mode 100644 docs/DeviceCommandsEvent.md delete mode 100644 docs/DeviceCommandsEventCommand.md delete mode 100644 docs/DeviceCommandsRequest.md delete mode 100644 docs/DeviceComponent.md delete mode 100644 docs/DeviceComponentReference.md delete mode 100644 docs/DeviceConfig.md delete mode 100644 docs/DeviceEvent.md delete mode 100644 docs/DeviceEventsRequest.md delete mode 100644 docs/DeviceHealthDetail.md delete mode 100644 docs/DeviceHealthEvent.md delete mode 100644 docs/DeviceInstallRequest.md delete mode 100644 docs/DeviceInstallRequestApp.md delete mode 100644 docs/DeviceIntegrationType.md delete mode 100644 docs/DeviceLifecycle.md delete mode 100644 docs/DeviceLifecycleDetail.md delete mode 100644 docs/DeviceLifecycleEvent.md delete mode 100644 docs/DeviceLifecycleMove.md delete mode 100644 docs/DeviceNetworkSecurityLevel.md delete mode 100644 docs/DeviceOperand.md delete mode 100644 docs/DeviceProfile.md delete mode 100644 docs/DeviceProfileReference.md delete mode 100644 docs/DeviceProfileStatus.md delete mode 100644 docs/DeviceResults.md delete mode 100644 docs/DeviceStateEvent.md delete mode 100644 docs/DeviceStatus.md delete mode 100644 docs/DeviceSubscriptionDetail.md delete mode 100644 docs/DeviceprofilesApi.md delete mode 100644 docs/DevicesApi.md delete mode 100644 docs/DthDeviceDetails.md delete mode 100644 docs/EndpointApp.md delete mode 100644 docs/EqualsCondition.md delete mode 100644 docs/Error.md delete mode 100644 docs/ErrorResponse.md delete mode 100644 docs/EventType.md delete mode 100644 docs/EveryAction.md delete mode 100644 docs/ExecutionResult.md delete mode 100644 docs/GenerateAppOAuthRequest.md delete mode 100644 docs/GenerateAppOAuthResponse.md delete mode 100644 docs/GetAppSettingsResponse.md delete mode 100644 docs/GreaterThanCondition.md delete mode 100644 docs/GreaterThanOrEqualsCondition.md delete mode 100644 docs/HubHealthDetail.md delete mode 100644 docs/HubHealthEvent.md delete mode 100644 docs/IconImage.md delete mode 100644 docs/IfAction.md delete mode 100644 docs/IfActionAllOf.md delete mode 100644 docs/InstallConfiguration.md delete mode 100644 docs/InstallConfigurationDetail.md delete mode 100644 docs/InstallConfigurationStatus.md delete mode 100644 docs/InstalledApp.md delete mode 100644 docs/InstalledAppIconImage.md delete mode 100644 docs/InstalledAppLifecycle.md delete mode 100644 docs/InstalledAppLifecycleError.md delete mode 100644 docs/InstalledAppLifecycleEvent.md delete mode 100644 docs/InstalledAppStatus.md delete mode 100644 docs/InstalledAppType.md delete mode 100644 docs/InstalledAppUi.md delete mode 100644 docs/InstalledappsApi.md delete mode 100644 docs/Interval.md delete mode 100644 docs/IntervalUnit.md delete mode 100644 docs/IrDeviceDetails.md delete mode 100644 docs/IrDeviceDetailsFunctionCodes.md delete mode 100644 docs/IsaResults.md delete mode 100644 docs/LambdaSmartApp.md delete mode 100644 docs/LessThanCondition.md delete mode 100644 docs/LessThanOrEqualsCondition.md delete mode 100644 docs/Link.md delete mode 100644 docs/Links.md delete mode 100644 docs/LocaleReference.md delete mode 100644 docs/LocaleVariables.md delete mode 100644 docs/Location.md delete mode 100644 docs/LocationAction.md delete mode 100644 docs/LocationAttribute.md delete mode 100644 docs/LocationOperand.md delete mode 100644 docs/LocationsApi.md delete mode 100644 docs/Message.md delete mode 100644 docs/MessageConfig.md delete mode 100644 docs/MessageTemplate.md delete mode 100644 docs/MessageType.md delete mode 100644 docs/Mode.md delete mode 100644 docs/ModeConfig.md delete mode 100644 docs/ModeEvent.md delete mode 100644 docs/ModeSubscriptionDetail.md delete mode 100644 docs/Notice.md delete mode 100644 docs/NoticeAction.md delete mode 100644 docs/NoticeCode.md delete mode 100644 docs/OnceSchedule.md delete mode 100644 docs/Operand.md delete mode 100644 docs/OperandAggregationMode.md delete mode 100644 docs/Owner.md delete mode 100644 docs/PagedApp.md delete mode 100644 docs/PagedApps.md delete mode 100644 docs/PagedDeviceProfiles.md delete mode 100644 docs/PagedDevices.md delete mode 100644 docs/PagedInstallConfigurations.md delete mode 100644 docs/PagedInstalledApps.md delete mode 100644 docs/PagedLocation.md delete mode 100644 docs/PagedLocations.md delete mode 100644 docs/PagedMessageTemplate.md delete mode 100644 docs/PagedRooms.md delete mode 100644 docs/PagedRules.md delete mode 100644 docs/PagedSchedules.md delete mode 100644 docs/PagedSubscriptions.md delete mode 100644 docs/ParentType.md delete mode 100644 docs/PermissionConfig.md delete mode 100644 docs/PredefinedMessage.md delete mode 100644 docs/PrincipalType.md delete mode 100644 docs/Room.md delete mode 100644 docs/RoomsApi.md delete mode 100644 docs/Rule.md delete mode 100644 docs/RuleAllOf.md delete mode 100644 docs/RuleExecutionResponse.md delete mode 100644 docs/RuleMetadata.md delete mode 100644 docs/RuleRequest.md delete mode 100644 docs/RulesApi.md delete mode 100644 docs/SceneAction.md delete mode 100644 docs/SceneArgument.md delete mode 100644 docs/SceneCapability.md delete mode 100644 docs/SceneCommand.md delete mode 100644 docs/SceneComponent.md delete mode 100644 docs/SceneConfig.md delete mode 100644 docs/SceneDevice.md delete mode 100644 docs/SceneDeviceGroup.md delete mode 100644 docs/SceneDeviceGroupRequest.md delete mode 100644 docs/SceneDeviceRequest.md delete mode 100644 docs/SceneLifecycle.md delete mode 100644 docs/SceneLifecycleDetail.md delete mode 100644 docs/SceneLifecycleEvent.md delete mode 100644 docs/SceneMode.md delete mode 100644 docs/SceneModeRequest.md delete mode 100644 docs/ScenePagedResult.md delete mode 100644 docs/SceneRequest.md delete mode 100644 docs/SceneSecurityModeRequest.md delete mode 100644 docs/SceneSleepRequest.md delete mode 100644 docs/SceneSummary.md delete mode 100644 docs/ScenesApi.md delete mode 100644 docs/Schedule.md delete mode 100644 docs/ScheduleRequest.md delete mode 100644 docs/SchedulesApi.md delete mode 100644 docs/SecurityArmStateDetail.md delete mode 100644 docs/SecurityArmStateEvent.md delete mode 100644 docs/SignatureType.md delete mode 100644 docs/SimpleCondition.md delete mode 100644 docs/SimpleValue.md delete mode 100644 docs/SingleOperandCondition.md delete mode 100644 docs/SleepAction.md delete mode 100644 docs/SmartAppDashboardCardEventRequest.md delete mode 100644 docs/SmartAppEventRequest.md delete mode 100644 docs/StandardSuccessResponse.md delete mode 100644 docs/StringConfig.md delete mode 100644 docs/Subscription.md delete mode 100644 docs/SubscriptionDelete.md delete mode 100644 docs/SubscriptionFilter.md delete mode 100644 docs/SubscriptionFilterTypes.md delete mode 100644 docs/SubscriptionMode.md delete mode 100644 docs/SubscriptionRequest.md delete mode 100644 docs/SubscriptionSource.md delete mode 100644 docs/SubscriptionTarget.md delete mode 100644 docs/SubscriptionsApi.md delete mode 100644 docs/TimeOperand.md delete mode 100644 docs/TimeReference.md delete mode 100644 docs/TimerEvent.md delete mode 100644 docs/TimerType.md delete mode 100644 docs/UpdateAppOAuthRequest.md delete mode 100644 docs/UpdateAppRequest.md delete mode 100644 docs/UpdateAppSettingsRequest.md delete mode 100644 docs/UpdateAppSettingsResponse.md delete mode 100644 docs/UpdateDeviceProfileRequest.md delete mode 100644 docs/UpdateDeviceRequest.md delete mode 100644 docs/UpdateDeviceRequestComponents.md delete mode 100644 docs/UpdateLocationRequest.md delete mode 100644 docs/UpdateRoomRequest.md delete mode 100644 docs/UpdateSignatureTypeRequest.md delete mode 100644 docs/ViperDeviceDetails.md delete mode 100644 docs/WebhookSmartApp.md diff --git a/GitVersion.yml b/GitVersion.yml index e1a8d8c..2bc7e26 100644 --- a/GitVersion.yml +++ b/GitVersion.yml @@ -1,5 +1,5 @@ mode: Mainline -next-version: 0.5.0 +next-version: 0.6.0 assembly-versioning-scheme: MajorMinorPatch assembly-file-versioning-format: '{Major}.{Minor}.{Patch}' assembly-informational-format: '{FullBuildMetaData}' diff --git a/LICENSE.txt b/LICENSE.txt index 55c0ce2..f686b2a 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020 J Dalton +Copyright (c) 2022 J Dalton Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/Action.md b/docs/Action.md deleted file mode 100644 index 124e6d2..0000000 --- a/docs/Action.md +++ /dev/null @@ -1,13 +0,0 @@ -# SmartThingsNet.Model.Action -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**If** | [**IfAction**](IfAction.md) | | [optional] -**Sleep** | [**SleepAction**](SleepAction.md) | | [optional] -**Command** | [**CommandAction**](CommandAction.md) | | [optional] -**Every** | [**EveryAction**](EveryAction.md) | | [optional] -**Location** | [**LocationAction**](LocationAction.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AdhocMessage.md b/docs/AdhocMessage.md deleted file mode 100644 index 7e5e491..0000000 --- a/docs/AdhocMessage.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.AdhocMessage -An adhoc message contains a list of message templates representing the same message in different locales. The system will serve the template with the locale that best matches the Recipient's language preferences. If the user's language preferences do not correlate to any message templates, the template defined by the `fallbackLocale` will be used. Variables from the template matching the locale of the Message will be assigned first, then `defaultVariables`. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**FallbackLocale** | **string** | The tag of the locale as defined in [RFC bcp47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt). | -**DefaultVariables** | **Dictionary<string, string>** | A map<string,string> with the key representing the variable name, and the value representing the verbiage to be replaced in template string. `defaultVariables` will only be used if there are no matching locale-level (template) variables for that key. | [optional] -**Templates** | [**List<AdhocMessageTemplate>**](AdhocMessageTemplate.md) | A list of templates representing the same message in different languages. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AdhocMessageTemplate.md b/docs/AdhocMessageTemplate.md deleted file mode 100644 index 00ef133..0000000 --- a/docs/AdhocMessageTemplate.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.AdhocMessageTemplate -A message template definition, representing a message in a specific locale and it's variables. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LocaleTag** | **string** | The tag of the locale as defined in [RFC bcp47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt). | -**Variables** | **Dictionary<string, string>** | A map<string,string> with the key representing the variable name, and the value representing the verbiage to be replaced in template string. | [optional] -**Template** | **string** | A message template string. Specify variables using the double curly braces convention. i.e. \"Hello, {{ firstName }}!\" | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/App.md b/docs/App.md deleted file mode 100644 index 212d6fa..0000000 --- a/docs/App.md +++ /dev/null @@ -1,24 +0,0 @@ -# SmartThingsNet.Model.App -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AppName** | **string** | A user defined unique identifier for an app. It is alpha-numeric, may contain dashes, underscores, periods, and be less then 250 characters long. It must be unique within your account. | [optional] -**AppId** | **Guid** | A globally unique identifier for an app. | [optional] -**AppType** | **AppType** | | [optional] -**PrincipalType** | **PrincipalType** | | [optional] -**Classifications** | [**List<AppClassification>**](AppClassification.md) | An App maybe associated to many classifications. A classification drives how the integration is presented to the user in the SmartThings mobile clients. These classifications include: * AUTOMATION - Denotes an integration that should display under the \"Automation\" tab in mobile clients. * SERVICE - Denotes an integration that is classified as a \"Service\". * DEVICE - Denotes an integration that should display under the \"Device\" tab in mobile clients. * CONNECTED_SERVICE - Denotes an integration that should display under the \"Connected Services\" menu in mobile clients. * HIDDEN - Denotes an integration that should not display in mobile clients | [optional] -**DisplayName** | **string** | A default display name for an app. | [optional] -**Description** | **string** | A default description for an app. | [optional] -**SingleInstance** | **bool** | Inform the installation systems that a particular app can only be installed once within a user's account. | [optional] [default to false] -**IconImage** | [**IconImage**](IconImage.md) | | [optional] -**InstallMetadata** | **Dictionary<string, string>** | System generated metadata that impacts eligibility requirements around installing an App. | [optional] -**Owner** | [**Owner**](Owner.md) | | [optional] -**CreatedDate** | **DateTime** | A UTC ISO-8601 Date-Time String | [optional] -**LastUpdatedDate** | **DateTime** | A UTC ISO-8601 Date-Time String | [optional] -**LambdaSmartApp** | [**LambdaSmartApp**](LambdaSmartApp.md) | | [optional] -**WebhookSmartApp** | [**WebhookSmartApp**](WebhookSmartApp.md) | | [optional] -**Ui** | [**AppUISettings**](AppUISettings.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AppClassification.md b/docs/AppClassification.md deleted file mode 100644 index e2f836c..0000000 --- a/docs/AppClassification.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.AppClassification -An App maybe associated to many classifications. A classification drives how the integration is presented to the user in the SmartThings mobile clients. These classifications include: * AUTOMATION - Denotes an integration that should display under the \"Automation\" tab in mobile clients. * SERVICE - Denotes an integration that is classified as a \"Service\". * DEVICE - Denotes an integration that should display under the \"Device\" tab in mobile clients. * CONNECTED_SERVICE - Denotes an integration that should display under the \"Connected Services\" menu in mobile clients. * HIDDEN - Denotes an integration that should not display in mobile clients -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AppDeviceDetails.md b/docs/AppDeviceDetails.md deleted file mode 100644 index 1c20304..0000000 --- a/docs/AppDeviceDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.AppDeviceDetails -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**InstalledAppId** | **string** | The ID of the installed app that integrates this device. | [optional] -**ExternalId** | **string** | A field to store an ID from a system external to SmartThings. | [optional] -**Profile** | [**DeviceProfileReference**](DeviceProfileReference.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AppOAuth.md b/docs/AppOAuth.md deleted file mode 100644 index 1115e7d..0000000 --- a/docs/AppOAuth.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.AppOAuth -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ClientName** | **string** | A name given to the OAuth Client. | [optional] -**Scope** | **List<string>** | A list of SmartThings API OAuth scope identifiers that maybe required to execute your integration. | [optional] -**RedirectUris** | **List<string>** | A list of redirect URIs. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AppTargetStatus.md b/docs/AppTargetStatus.md deleted file mode 100644 index 7502c90..0000000 --- a/docs/AppTargetStatus.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.AppTargetStatus -The registration status of a target url. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AppType.md b/docs/AppType.md deleted file mode 100644 index 6af7639..0000000 --- a/docs/AppType.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.AppType -Denotes the type of app. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AppUISettings.md b/docs/AppUISettings.md deleted file mode 100644 index dc6b3d4..0000000 --- a/docs/AppUISettings.md +++ /dev/null @@ -1,13 +0,0 @@ -# SmartThingsNet.Model.AppUISettings -A collection of settings to drive user interface in SmartThings clients. Currently, only applicable for LAMBDA_SMART_APP and WEBHOOK_SMART_APP app types. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**PluginId** | **string** | | [optional] -**PluginUri** | **string** | | [optional] -**DashboardCardsEnabled** | **bool** | | -**PreInstallDashboardCardsEnabled** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AppsApi.md b/docs/AppsApi.md deleted file mode 100644 index 02bc10d..0000000 --- a/docs/AppsApi.md +++ /dev/null @@ -1,996 +0,0 @@ -# SmartThingsNet.Api.AppsApi - -All URIs are relative to *https://api.smartthings.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateApp**](AppsApi.md#createapp) | **POST** /apps | Create an app. -[**DeleteApp**](AppsApi.md#deleteapp) | **DELETE** /apps/{appNameOrId} | Delete an app. -[**GenerateAppOauth**](AppsApi.md#generateappoauth) | **POST** /apps/{appNameOrId}/oauth/generate | Generate an app's oauth client/secret. -[**GetApp**](AppsApi.md#getapp) | **GET** /apps/{appNameOrId} | Get an app. -[**GetAppOauth**](AppsApi.md#getappoauth) | **GET** /apps/{appNameOrId}/oauth | Get an app's oauth settings. -[**GetAppSettings**](AppsApi.md#getappsettings) | **GET** /apps/{appNameOrId}/settings | Get settings. -[**ListApps**](AppsApi.md#listapps) | **GET** /apps | List apps. -[**Register**](AppsApi.md#register) | **PUT** /apps/{appNameOrId}/register | Sends a confirmation request to App. -[**UpdateApp**](AppsApi.md#updateapp) | **PUT** /apps/{appNameOrId} | Update an app. -[**UpdateAppOauth**](AppsApi.md#updateappoauth) | **PUT** /apps/{appNameOrId}/oauth | Update an app's oauth settings. -[**UpdateAppSettings**](AppsApi.md#updateappsettings) | **PUT** /apps/{appNameOrId}/settings | Update settings. -[**UpdateSignatureType**](AppsApi.md#updatesignaturetype) | **PUT** /apps/{appNameOrId}/signature-type | Update an app's signature type. - - - -# **CreateApp** -> CreateAppResponse CreateApp (CreateAppRequest createOrUpdateAppRequest, string signatureType = null, bool? requireConfirmation = null) - -Create an app. - -Create an app integration. A single developer account is allowed to contain a maximum of 100 apps. Upon hitting that limit a 422 error response is returned with an error code of LimitError. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class CreateAppExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var createOrUpdateAppRequest = new CreateAppRequest(); // CreateAppRequest | - var signatureType = signatureType_example; // string | The Signature Type of the application. For WEBHOOK_SMART_APP only. (optional) - var requireConfirmation = true; // bool? | Override default configuration to use either PING or CONFIRMATION lifecycle. For WEBHOOK_SMART_APP only. (optional) - - try - { - // Create an app. - CreateAppResponse result = apiInstance.CreateApp(createOrUpdateAppRequest, signatureType, requireConfirmation); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.CreateApp: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **createOrUpdateAppRequest** | [**CreateAppRequest**](CreateAppRequest.md)| | - **signatureType** | **string**| The Signature Type of the application. For WEBHOOK_SMART_APP only. | [optional] - **requireConfirmation** | **bool?**| Override default configuration to use either PING or CONFIRMATION lifecycle. For WEBHOOK_SMART_APP only. | [optional] - -### Return type - -[**CreateAppResponse**](CreateAppResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An app model. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **DeleteApp** -> Object DeleteApp (string appNameOrId) - -Delete an app. - -Delete an app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class DeleteAppExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var appNameOrId = appNameOrId_example; // string | The appName or appId field of an app. - - try - { - // Delete an app. - Object result = apiInstance.DeleteApp(appNameOrId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.DeleteApp: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **appNameOrId** | **string**| The appName or appId field of an app. | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The number of deleted apps. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GenerateAppOauth** -> GenerateAppOAuthResponse GenerateAppOauth (string appNameOrId, GenerateAppOAuthRequest generateAppOAuthRequest) - -Generate an app's oauth client/secret. - -When an app is first created an OAuth client/secret are automatically generated for the integration. However, there are times when it maybe useful to re-generate a client/secret. Such as in cases where a secret becomes compromised. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GenerateAppOauthExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var appNameOrId = appNameOrId_example; // string | The appName or appId field of an app. - var generateAppOAuthRequest = new GenerateAppOAuthRequest(); // GenerateAppOAuthRequest | - - try - { - // Generate an app's oauth client/secret. - GenerateAppOAuthResponse result = apiInstance.GenerateAppOauth(appNameOrId, generateAppOAuthRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.GenerateAppOauth: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **appNameOrId** | **string**| The appName or appId field of an app. | - **generateAppOAuthRequest** | [**GenerateAppOAuthRequest**](GenerateAppOAuthRequest.md)| | - -### Return type - -[**GenerateAppOAuthResponse**](GenerateAppOAuthResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An a response object containing the newly create OAuth Client ID / Secret and relevant details pertaining to the OAuth client. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetApp** -> App GetApp (string appNameOrId) - -Get an app. - -Get a single app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetAppExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var appNameOrId = appNameOrId_example; // string | The appName or appId field of an app. - - try - { - // Get an app. - App result = apiInstance.GetApp(appNameOrId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.GetApp: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **appNameOrId** | **string**| The appName or appId field of an app. | - -### Return type - -[**App**](App.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An app. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetAppOauth** -> AppOAuth GetAppOauth (string appNameOrId) - -Get an app's oauth settings. - -Get an app's oauth settings. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetAppOauthExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var appNameOrId = appNameOrId_example; // string | The appName or appId field of an app. - - try - { - // Get an app's oauth settings. - AppOAuth result = apiInstance.GetAppOauth(appNameOrId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.GetAppOauth: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **appNameOrId** | **string**| The appName or appId field of an app. | - -### Return type - -[**AppOAuth**](AppOAuth.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An app. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetAppSettings** -> GetAppSettingsResponse GetAppSettings (string appNameOrId) - -Get settings. - -Get settings for an app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetAppSettingsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var appNameOrId = appNameOrId_example; // string | The appName or appId field of an app. - - try - { - // Get settings. - GetAppSettingsResponse result = apiInstance.GetAppSettings(appNameOrId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.GetAppSettings: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **appNameOrId** | **string**| The appName or appId field of an app. | - -### Return type - -[**GetAppSettingsResponse**](GetAppSettingsResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An app settings model. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **ListApps** -> PagedApps ListApps (string appType = null, string classification = null, string tag = null) - -List apps. - -List all apps configured in an account. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ListAppsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var appType = appType_example; // string | The App Type of the application. (optional) - var classification = classification_example; // string | An App maybe associated to many classifications. A classification drives how the integration is presented to the user in the SmartThings mobile clients. These classifications include: * AUTOMATION - Denotes an integration that should display under the \"Automation\" tab in mobile clients. * SERVICE - Denotes an integration that is classified as a \"Service\". * DEVICE - Denotes an integration that should display under the \"Device\" tab in mobile clients. * CONNECTED_SERVICE - Denotes an integration that should display under the \"Connected Services\" menu in mobile clients. (optional) - var tag = tag_example; // string | May be used to filter a resource by it's assigned user-tags. Multiple tag query params are automatically joined with OR. Example usage in query string: ``` ?tag:key_name=value1&tag:key_name=value2 ``` (optional) - - try - { - // List apps. - PagedApps result = apiInstance.ListApps(appType, classification, tag); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.ListApps: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **appType** | **string**| The App Type of the application. | [optional] - **classification** | **string**| An App maybe associated to many classifications. A classification drives how the integration is presented to the user in the SmartThings mobile clients. These classifications include: * AUTOMATION - Denotes an integration that should display under the \"Automation\" tab in mobile clients. * SERVICE - Denotes an integration that is classified as a \"Service\". * DEVICE - Denotes an integration that should display under the \"Device\" tab in mobile clients. * CONNECTED_SERVICE - Denotes an integration that should display under the \"Connected Services\" menu in mobile clients. | [optional] - **tag** | **string**| May be used to filter a resource by it's assigned user-tags. Multiple tag query params are automatically joined with OR. Example usage in query string: ``` ?tag:key_name=value1&tag:key_name=value2 ``` | [optional] - -### Return type - -[**PagedApps**](PagedApps.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | A paginated list of apps. | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **Register** -> Object Register (string appNameOrId, Object appRegisterRequest) - -Sends a confirmation request to App. - -Prepares to register an App by sending the endpoint a confirmation message. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class RegisterExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var appNameOrId = appNameOrId_example; // string | The appName or appId field of an app. - var appRegisterRequest = ; // Object | - - try - { - // Sends a confirmation request to App. - Object result = apiInstance.Register(appNameOrId, appRegisterRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.Register: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **appNameOrId** | **string**| The appName or appId field of an app. | - **appRegisterRequest** | **Object**| | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **202** | A request to send a confirm registration request has been accepted. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **UpdateApp** -> App UpdateApp (string appNameOrId, UpdateAppRequest updateAppRequest, string signatureType = null, bool? requireConfirmation = null) - -Update an app. - -Update an app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class UpdateAppExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var appNameOrId = appNameOrId_example; // string | The appName or appId field of an app. - var updateAppRequest = new UpdateAppRequest(); // UpdateAppRequest | - var signatureType = signatureType_example; // string | The Signature Type of the application. For WEBHOOK_SMART_APP only. (optional) - var requireConfirmation = true; // bool? | Override default configuration to use either PING or CONFIRMATION lifecycle. For WEBHOOK_SMART_APP only. (optional) - - try - { - // Update an app. - App result = apiInstance.UpdateApp(appNameOrId, updateAppRequest, signatureType, requireConfirmation); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.UpdateApp: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **appNameOrId** | **string**| The appName or appId field of an app. | - **updateAppRequest** | [**UpdateAppRequest**](UpdateAppRequest.md)| | - **signatureType** | **string**| The Signature Type of the application. For WEBHOOK_SMART_APP only. | [optional] - **requireConfirmation** | **bool?**| Override default configuration to use either PING or CONFIRMATION lifecycle. For WEBHOOK_SMART_APP only. | [optional] - -### Return type - -[**App**](App.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An app model. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **UpdateAppOauth** -> AppOAuth UpdateAppOauth (string appNameOrId, UpdateAppOAuthRequest updateAppOAuthRequest) - -Update an app's oauth settings. - -Update an app's oauth settings. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class UpdateAppOauthExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var appNameOrId = appNameOrId_example; // string | The appName or appId field of an app. - var updateAppOAuthRequest = new UpdateAppOAuthRequest(); // UpdateAppOAuthRequest | - - try - { - // Update an app's oauth settings. - AppOAuth result = apiInstance.UpdateAppOauth(appNameOrId, updateAppOAuthRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.UpdateAppOauth: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **appNameOrId** | **string**| The appName or appId field of an app. | - **updateAppOAuthRequest** | [**UpdateAppOAuthRequest**](UpdateAppOAuthRequest.md)| | - -### Return type - -[**AppOAuth**](AppOAuth.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An app's oauth settings model. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **UpdateAppSettings** -> UpdateAppSettingsResponse UpdateAppSettings (string appNameOrId, UpdateAppSettingsRequest updateAppSettingsRequest) - -Update settings. - -Update settings for an app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class UpdateAppSettingsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var appNameOrId = appNameOrId_example; // string | The appName or appId field of an app. - var updateAppSettingsRequest = new UpdateAppSettingsRequest(); // UpdateAppSettingsRequest | - - try - { - // Update settings. - UpdateAppSettingsResponse result = apiInstance.UpdateAppSettings(appNameOrId, updateAppSettingsRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.UpdateAppSettings: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **appNameOrId** | **string**| The appName or appId field of an app. | - **updateAppSettingsRequest** | [**UpdateAppSettingsRequest**](UpdateAppSettingsRequest.md)| | - -### Return type - -[**UpdateAppSettingsResponse**](UpdateAppSettingsResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An app settings model. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **UpdateSignatureType** -> Object UpdateSignatureType (string appNameOrId, UpdateSignatureTypeRequest updateSignatureTypeRequest) - -Update an app's signature type. - -Updates the signature type of an App. Signature options: * APP_RSA - Legacy signing mechanism comprised of a public / private key generated for an App during registration. This mechanism requires an App to download the public key and deploy along side their integration to verify the signature in the authorization header. * ST_PADLOCK - App callbacks are signed with a SmartThings certificate which is publicly available at https://key.smartthings.com. App's authorize callbacks by fetching the certificate over HTTPS and using it to validate the signature in the authorization header. Note that when upgrading an App from APP_RSA to ST_PADLOCK it is recommended to implement both verification methods. This will provide the ability to seamlessly switch between mechanisms in case a rollback is needed. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class UpdateSignatureTypeExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AppsApi(config); - - var appNameOrId = appNameOrId_example; // string | The appName or appId field of an app. - var updateSignatureTypeRequest = new UpdateSignatureTypeRequest(); // UpdateSignatureTypeRequest | - - try - { - // Update an app's signature type. - Object result = apiInstance.UpdateSignatureType(appNameOrId, updateSignatureTypeRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling AppsApi.UpdateSignatureType: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **appNameOrId** | **string**| The appName or appId field of an app. | - **updateSignatureTypeRequest** | [**UpdateSignatureTypeRequest**](UpdateSignatureTypeRequest.md)| | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **202** | App signature type will be updated asynchronously. Developer can expect change to take effect within a few minutes. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Argument.md b/docs/Argument.md deleted file mode 100644 index d70af85..0000000 --- a/docs/Argument.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.Argument -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | A name that is unique within the command. Used for i18n and named argument command execution. | -**Optional** | **bool** | Whether or not the argument must be supplied. If the argument is at the end of the arguments array then it can be completely ignored. If the argument is followed by another argument `null` must be supplied. | [optional] [default to false] -**Schema** | **Object** | [JSON schema](http://json-schema.org/specification-links.html#draft-4) for the argument. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ArrayOperand.md b/docs/ArrayOperand.md deleted file mode 100644 index 7144c58..0000000 --- a/docs/ArrayOperand.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.ArrayOperand -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operands** | [**List<Operand>**](Operand.md) | | -**Aggregation** | **OperandAggregationMode** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AttributeProperties.md b/docs/AttributeProperties.md deleted file mode 100644 index 7252e17..0000000 --- a/docs/AttributeProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.AttributeProperties -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | **Dictionary<string, Object>** | | -**Unit** | [**AttributePropertiesUnit**](AttributePropertiesUnit.md) | | [optional] -**Data** | [**AttributePropertiesData**](AttributePropertiesData.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AttributePropertiesData.md b/docs/AttributePropertiesData.md deleted file mode 100644 index 4caa1c9..0000000 --- a/docs/AttributePropertiesData.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.AttributePropertiesData -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **string** | | [default to TypeEnum.Object] -**AdditionalProperties** | **bool** | | [optional] [default to false] -**Required** | **List<string>** | | [optional] -**Properties** | **Object** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AttributePropertiesUnit.md b/docs/AttributePropertiesUnit.md deleted file mode 100644 index 83313bc..0000000 --- a/docs/AttributePropertiesUnit.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.AttributePropertiesUnit -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **string** | | [optional] [default to TypeEnum.String] -**Enum** | **List<string>** | | [optional] -**Default** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AttributeSchema.md b/docs/AttributeSchema.md deleted file mode 100644 index 6a3c489..0000000 --- a/docs/AttributeSchema.md +++ /dev/null @@ -1,14 +0,0 @@ -# SmartThingsNet.Model.AttributeSchema -[JSON schema](http://json-schema.org/specification-links.html#draft-4) for the attribute. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Title** | **string** | | [optional] -**Type** | **string** | | [default to TypeEnum.Object] -**Properties** | [**AttributeProperties**](AttributeProperties.md) | | -**AdditionalProperties** | **bool** | | -**Required** | **List<string>** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AttributeState.md b/docs/AttributeState.md deleted file mode 100644 index 0beadc2..0000000 --- a/docs/AttributeState.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.AttributeState -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | **Object** | | [optional] -**Unit** | **string** | | [optional] -**Data** | **Dictionary<string, Object>** | | [optional] -**Timestamp** | **DateTime** | Will always be 0 timezone offset | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/BetweenCondition.md b/docs/BetweenCondition.md deleted file mode 100644 index 4a4cc22..0000000 --- a/docs/BetweenCondition.md +++ /dev/null @@ -1,13 +0,0 @@ -# SmartThingsNet.Model.BetweenCondition -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the condition | [optional] -**Value** | [**Operand**](Operand.md) | | -**Start** | [**Operand**](Operand.md) | | -**End** | [**Operand**](Operand.md) | | -**Aggregation** | **ConditionAggregationMode** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CapabilityAttribute.md b/docs/CapabilityAttribute.md deleted file mode 100644 index ac239f2..0000000 --- a/docs/CapabilityAttribute.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.CapabilityAttribute -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Schema** | [**AttributeSchema**](AttributeSchema.md) | | [optional] -**Setter** | **string** | The name of the command that sets this attribute | [optional] -**EnumCommands** | [**List<CapabilityAttributeEnumCommands>**](CapabilityAttributeEnumCommands.md) | a list of objects that specify which commands set this attribute | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CapabilityAttributeEnumCommands.md b/docs/CapabilityAttributeEnumCommands.md deleted file mode 100644 index e64c37b..0000000 --- a/docs/CapabilityAttributeEnumCommands.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.CapabilityAttributeEnumCommands -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Command** | **string** | the command that sets this attribute to the associated value | [optional] -**Value** | **string** | the value that this command will set the attribute to | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CapabilityCommand.md b/docs/CapabilityCommand.md deleted file mode 100644 index fc8e431..0000000 --- a/docs/CapabilityCommand.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.CapabilityCommand -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | The name of the command. Unique for the capability | -**Arguments** | [**List<Argument>**](Argument.md) | An array of argument definitions. The arguments must be supplied in the order specified. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CapabilityReference.md b/docs/CapabilityReference.md deleted file mode 100644 index 6166452..0000000 --- a/docs/CapabilityReference.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.CapabilityReference -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | | -**Version** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CapabilitySubscriptionDetail.md b/docs/CapabilitySubscriptionDetail.md deleted file mode 100644 index 30ed1f4..0000000 --- a/docs/CapabilitySubscriptionDetail.md +++ /dev/null @@ -1,16 +0,0 @@ -# SmartThingsNet.Model.CapabilitySubscriptionDetail -Details of a subscription of source type CAPABILITY. The combination of subscribed values must be unique per installed app. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LocationId** | **string** | The id of the location that both the app and source device are in. | -**Capability** | **string** | Name of the capability that is subscribed to. | -**Attribute** | **string** | Name of the capabilities attribute or * for all. | [optional] [default to "*"] -**Value** | **Object** | A particular value for the attribute that will trigger the subscription or * for all. | [optional] -**StateChangeOnly** | **bool** | Only execute the subscription if the subscribed event is a state change from previous events. | [optional] [default to true] -**SubscriptionName** | **string** | A name for the subscription that will be passed to the installed app. Must be unique per installed app. | [optional] -**Modes** | **List<string>** | List of modes that the subscription will execute for. If not provided then all modes will be supported. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CapabilitySummary.md b/docs/CapabilitySummary.md deleted file mode 100644 index 7afc2b5..0000000 --- a/docs/CapabilitySummary.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.CapabilitySummary -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | A URL safe unique identifier for the capability. | [optional] -**Version** | **int** | The version number of the capability. | [optional] -**Status** | **string** | The status of the capability. * __proposed__ - The capability is under a review and refinement process. The capability definition may go through changes, some of which may be breaking. * __live__ - The capability has been through review and the definition has been solidified. Live capabilities can no longer be altered. * __deprecated__ - The capability is marked for removal and should only be used during a period of migration to allow for existing integrations and automations to continue to work. * __dead__ - The usage of a deprecated capability has dropped to a sufficiently low level to warrant removal. The capability definition still exists but can no longer be used by automations or implemented by devices. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ChangesCondition.md b/docs/ChangesCondition.md deleted file mode 100644 index 2d407d8..0000000 --- a/docs/ChangesCondition.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.ChangesCondition -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the condition | [optional] -**Left** | [**Operand**](Operand.md) | | -**Aggregation** | [**ConditionAggregationMode**](ConditionAggregationMode.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CommandAction.md b/docs/CommandAction.md deleted file mode 100644 index 714ffb0..0000000 --- a/docs/CommandAction.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.CommandAction -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the action | [optional] -**Devices** | **List<string>** | | -**Commands** | [**List<DeviceCommand>**](DeviceCommand.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ComponentTranslations.md b/docs/ComponentTranslations.md deleted file mode 100644 index 283c8f2..0000000 --- a/docs/ComponentTranslations.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.ComponentTranslations -A map of i18n translations. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Label** | **string** | Short UTF-8 text used when displaying the component. | [optional] -**Description** | **string** | UTF-8 text describing the component. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Condition.md b/docs/Condition.md deleted file mode 100644 index fbc933d..0000000 --- a/docs/Condition.md +++ /dev/null @@ -1,18 +0,0 @@ -# SmartThingsNet.Model.Condition -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**And** | [**List<Condition>**](Condition.md) | | [optional] -**Or** | [**List<Condition>**](Condition.md) | | [optional] -**Not** | [**Condition**](Condition.md) | | [optional] -**Equals** | [**EqualsCondition**](EqualsCondition.md) | | [optional] -**GreaterThan** | [**GreaterThanCondition**](GreaterThanCondition.md) | | [optional] -**GreaterThanOrEquals** | [**GreaterThanOrEqualsCondition**](GreaterThanOrEqualsCondition.md) | | [optional] -**LessThan** | [**LessThanCondition**](LessThanCondition.md) | | [optional] -**LessThanOrEquals** | [**LessThanOrEqualsCondition**](LessThanOrEqualsCondition.md) | | [optional] -**Between** | [**BetweenCondition**](BetweenCondition.md) | | [optional] -**Changes** | [**ChangesCondition**](ChangesCondition.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ConditionAggregationMode.md b/docs/ConditionAggregationMode.md deleted file mode 100644 index f562046..0000000 --- a/docs/ConditionAggregationMode.md +++ /dev/null @@ -1,8 +0,0 @@ -# SmartThingsNet.Model.ConditionAggregationMode -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ConfigEntry.md b/docs/ConfigEntry.md deleted file mode 100644 index 62b6a1f..0000000 --- a/docs/ConfigEntry.md +++ /dev/null @@ -1,16 +0,0 @@ -# SmartThingsNet.Model.ConfigEntry -A configuration value type and the correspodning configuration. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ValueType** | **string** | The value type. | [optional] -**StringConfig** | [**StringConfig**](StringConfig.md) | | [optional] -**DeviceConfig** | [**DeviceConfig**](DeviceConfig.md) | | [optional] -**PermissionConfig** | [**PermissionConfig**](PermissionConfig.md) | | [optional] -**ModeConfig** | [**ModeConfig**](ModeConfig.md) | | [optional] -**SceneConfig** | [**SceneConfig**](SceneConfig.md) | | [optional] -**MessageConfig** | [**MessageConfig**](MessageConfig.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateAppRequest.md b/docs/CreateAppRequest.md deleted file mode 100644 index 676c1ca..0000000 --- a/docs/CreateAppRequest.md +++ /dev/null @@ -1,20 +0,0 @@ -# SmartThingsNet.Model.CreateAppRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AppName** | **string** | A globally unique, developer-defined identifier for an app. It is alpha-numeric, may contain dashes, underscores, periods, and must be less then 250 characters long. | -**DisplayName** | **string** | A default display name for an app. | -**Description** | **string** | A default description for an app. | -**SingleInstance** | **bool** | Inform the installation systems that a particular app can only be installed once within a user's account. | [optional] [default to false] -**IconImage** | [**IconImage**](IconImage.md) | | [optional] -**AppType** | **AppType** | | -**PrincipalType** | **PrincipalType** | | [optional] -**Classifications** | [**List<AppClassification>**](AppClassification.md) | An App maybe associated to many classifications. A classification drives how the integration is presented to the user in the SmartThings mobile clients. These classifications include: * AUTOMATION - Denotes an integration that should display under the \"Automation\" tab in mobile clients. * SERVICE - Denotes an integration that is classified as a \"Service\". * DEVICE - Denotes an integration that should display under the \"Device\" tab in mobile clients. * CONNECTED_SERVICE - Denotes an integration that should display under the \"Connected Services\" menu in mobile clients. * HIDDEN - Denotes an integration that should not display in mobile clients | -**LambdaSmartApp** | [**CreateOrUpdateLambdaSmartAppRequest**](CreateOrUpdateLambdaSmartAppRequest.md) | | [optional] -**WebhookSmartApp** | [**CreateOrUpdateWebhookSmartAppRequest**](CreateOrUpdateWebhookSmartAppRequest.md) | | [optional] -**Oauth** | [**AppOAuth**](AppOAuth.md) | | [optional] -**Ui** | [**AppUISettings**](AppUISettings.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateAppResponse.md b/docs/CreateAppResponse.md deleted file mode 100644 index 08390ea..0000000 --- a/docs/CreateAppResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.CreateAppResponse -A response object containing the newly created App and OAuth client details. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**App** | [**App**](App.md) | | [optional] -**OauthClientId** | **Guid** | The OAuth Client ID. | [optional] -**OauthClientSecret** | **Guid** | The OAuth Client Secret. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateDeviceProfileRequest.md b/docs/CreateDeviceProfileRequest.md deleted file mode 100644 index 5e37611..0000000 --- a/docs/CreateDeviceProfileRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.CreateDeviceProfileRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | A name for the device profile. | -**Components** | [**List<DeviceComponentReference>**](DeviceComponentReference.md) | A list of components for this profile. Exactly 1 component ID must be `main`. | -**Metadata** | **Dictionary<string, string>** | Additional information about the device profile, limited to 10 entries. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateInstalledAppEventsRequest.md b/docs/CreateInstalledAppEventsRequest.md deleted file mode 100644 index b362faa..0000000 --- a/docs/CreateInstalledAppEventsRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.CreateInstalledAppEventsRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SmartAppEvents** | [**List<SmartAppEventRequest>**](SmartAppEventRequest.md) | An array of smartapp events used to trigger client behavior in loaded web plugin detail pages. Events will be delivered to JavaScript event handler of all active client processes related to parameterized installed app. | [optional] -**SmartAppDashboardCardEvents** | [**List<SmartAppDashboardCardEventRequest>**](SmartAppDashboardCardEventRequest.md) | An array of smartapp dashboard card events used to trigger client behavior for dashboard cards. Dashboard card events are directives to a SmartThings client to take actions in relation to lifecycle changes to a specific dashboard card. These events are not delivered to the web plugin event handler. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateLocationRequest.md b/docs/CreateLocationRequest.md deleted file mode 100644 index a987aa0..0000000 --- a/docs/CreateLocationRequest.md +++ /dev/null @@ -1,16 +0,0 @@ -# SmartThingsNet.Model.CreateLocationRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | A nickname given for the location (eg. Home) | -**CountryCode** | **string** | An ISO Alpha-3 country code. (i.e. GBR, USA) | -**Latitude** | **decimal** | A geographical latitude. | [optional] -**Longitude** | **decimal** | A geographical longitude. | [optional] -**RegionRadius** | **int** | The radius in meters around latitude and longitude which defines this location. | [optional] -**TemperatureScale** | **string** | The desired temperature scale used within location. Value can be F or C. | [optional] -**Locale** | **string** | An IETF BCP 47 language tag representing the chosen locale for this location. | [optional] -**AdditionalProperties** | **Dictionary<string, string>** | Additional information about the location that allows SmartThings to further define your location. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateOrUpdateLambdaSmartAppRequest.md b/docs/CreateOrUpdateLambdaSmartAppRequest.md deleted file mode 100644 index def6ec9..0000000 --- a/docs/CreateOrUpdateLambdaSmartAppRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.CreateOrUpdateLambdaSmartAppRequest -Details related to a Lambda Smart App implementation. This model should only be specified for apps of type LAMBDA_SMART_APP. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Functions** | **List<string>** | A list of AWS arns referencing a Lambda function. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateOrUpdateWebhookSmartAppRequest.md b/docs/CreateOrUpdateWebhookSmartAppRequest.md deleted file mode 100644 index ecd955e..0000000 --- a/docs/CreateOrUpdateWebhookSmartAppRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.CreateOrUpdateWebhookSmartAppRequest -Details related to a Webhook Smart App implementation. This model should only be specified for apps of type WEBHOOK_SMART_APP. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TargetUrl** | **string** | A URL that should be invoked during execution. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateRoomRequest.md b/docs/CreateRoomRequest.md deleted file mode 100644 index 98afcd2..0000000 --- a/docs/CreateRoomRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.CreateRoomRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | A name given for the room (eg. Living Room) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CronSchedule.md b/docs/CronSchedule.md deleted file mode 100644 index be2e8c0..0000000 --- a/docs/CronSchedule.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.CronSchedule -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Expression** | **string** | The cron expression for the schedule for CRON schedules. The format matches that specified by the [Quartz scheduler](http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/crontrigger.html) but should not include the seconds (1st) field. The exact second will be chosen at random but will remain consistent. The years part must be les than 2 years from now. | -**Timezone** | **string** | The timezone id for CRON schedules. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DashboardCardLifecycle.md b/docs/DashboardCardLifecycle.md deleted file mode 100644 index 66c624d..0000000 --- a/docs/DashboardCardLifecycle.md +++ /dev/null @@ -1,8 +0,0 @@ -# SmartThingsNet.Model.DashboardCardLifecycle -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DateOperand.md b/docs/DateOperand.md deleted file mode 100644 index 3b4836d..0000000 --- a/docs/DateOperand.md +++ /dev/null @@ -1,13 +0,0 @@ -# SmartThingsNet.Model.DateOperand -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TimeZoneId** | **string** | A java time zone ID reference | [optional] -**DaysOfWeek** | [**List<DayOfWeek>**](DayOfWeek.md) | | [optional] -**Year** | **int** | | [optional] -**Month** | **int** | | [optional] -**Day** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DateTimeOperand.md b/docs/DateTimeOperand.md deleted file mode 100644 index a6e4eb1..0000000 --- a/docs/DateTimeOperand.md +++ /dev/null @@ -1,15 +0,0 @@ -# SmartThingsNet.Model.DateTimeOperand -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TimeZoneId** | **string** | A java time zone ID reference | [optional] -**DaysOfWeek** | [**List<DayOfWeek>**](DayOfWeek.md) | | [optional] -**Year** | **int** | | [optional] -**Month** | **int** | | [optional] -**Day** | **int** | | [optional] -**Reference** | **TimeReference** | | -**Offset** | [**Interval**](Interval.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DayOfWeek.md b/docs/DayOfWeek.md deleted file mode 100644 index 9086955..0000000 --- a/docs/DayOfWeek.md +++ /dev/null @@ -1,8 +0,0 @@ -# SmartThingsNet.Model.DayOfWeek -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeleteInstalledAppResponse.md b/docs/DeleteInstalledAppResponse.md deleted file mode 100644 index 5b3dbe4..0000000 --- a/docs/DeleteInstalledAppResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.DeleteInstalledAppResponse -The number of deleted installed apps. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Count** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Device.md b/docs/Device.md deleted file mode 100644 index a30e8a3..0000000 --- a/docs/Device.md +++ /dev/null @@ -1,26 +0,0 @@ -# SmartThingsNet.Model.Device -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceId** | **string** | The identifier for the device instance. | [optional] -**Name** | **string** | The name that the device integration (Device Handler or SmartApp) defines for the device. | [optional] -**Label** | **string** | The name that a user chooses for the device. This defaults to the same value as name. | [optional] -**DeviceManufacturerCode** | **string** | The device manufacturer code. | [optional] -**LocationId** | **string** | The ID of the Location with which the device is associated. | [optional] -**RoomId** | **string** | The ID of the Room with which the device is associated. If the device is not associated with any room, then this field will be null. | [optional] -**DeviceTypeId** | **string** | Deprecated please look under \"dth\". | [optional] -**DeviceTypeName** | **string** | Deprecated please look under \"dth\". | [optional] -**DeviceNetworkType** | **string** | Deprecated please look under \"dth\". | [optional] -**Components** | [**List<DeviceComponent>**](DeviceComponent.md) | The IDs of all compenents on the device. | [optional] -**ChildDevices** | [**List<Device>**](Device.md) | Device details for all child devices of the device. | [optional] -**Profile** | [**DeviceProfileReference**](DeviceProfileReference.md) | | [optional] -**App** | [**AppDeviceDetails**](AppDeviceDetails.md) | | [optional] -**Dth** | [**DthDeviceDetails**](DthDeviceDetails.md) | | [optional] -**Ir** | [**IrDeviceDetails**](IrDeviceDetails.md) | | [optional] -**IrOcf** | [**IrDeviceDetails**](IrDeviceDetails.md) | | [optional] -**Viper** | [**ViperDeviceDetails**](ViperDeviceDetails.md) | | [optional] -**Type** | **DeviceIntegrationType** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceActivity.md b/docs/DeviceActivity.md deleted file mode 100644 index 2f5f7f8..0000000 --- a/docs/DeviceActivity.md +++ /dev/null @@ -1,21 +0,0 @@ -# SmartThingsNet.Model.DeviceActivity -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceId** | **string** | Device ID | [optional] -**DeviceName** | **string** | Device nick name | [optional] -**LocationId** | **string** | Location ID | [optional] -**LocationName** | **string** | Location name | [optional] -**Time** | **DateTime** | The IS0-8601 date time strings in UTC of the activity | [optional] -**Text** | **string** | Translated human readable string (localized) | [optional] -**Component** | **string** | device component ID. Not nullable. | -**ComponentLabel** | **string** | device component label. Nullable. | [optional] -**Capability** | **string** | capability name | [optional] -**Attribute** | **string** | attribute name | [optional] -**Value** | **Object** | attribute value | [optional] -**Unit** | **string** | | [optional] -**Data** | **Dictionary<string, Object>** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceCategory.md b/docs/DeviceCategory.md deleted file mode 100644 index c45151d..0000000 --- a/docs/DeviceCategory.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.DeviceCategory -A case-sensitive string from the pre-defined list of valid categories [/devicecategories](#/operation/listCategories). -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceCommand.md b/docs/DeviceCommand.md deleted file mode 100644 index 0b81ff9..0000000 --- a/docs/DeviceCommand.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.DeviceCommand -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Component** | **string** | The name of the component on this device, default is 'main'. The component must be valid for the device. | [optional] [default to "main"] -**Capability** | **string** | Capability that this command relates to. This must be a capability of the component. | -**Command** | **string** | Name of the command, this must be valid for the capability. | -**Arguments** | **List<Object>** | Arguments of the command. All the required arguments defined in the capability's command argument definition must be provided. The type of the arguments are dependent on the type of the capability's command argument. Please refer to the capabilities definition at https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceCommandsEvent.md b/docs/DeviceCommandsEvent.md deleted file mode 100644 index 7bdd2fb..0000000 --- a/docs/DeviceCommandsEvent.md +++ /dev/null @@ -1,14 +0,0 @@ -# SmartThingsNet.Model.DeviceCommandsEvent -An event that contains commands for devices that were created by this app. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EventId** | **string** | The id of the event. | [optional] -**DeviceId** | **string** | The guid of the device that the commands are for. | [optional] -**ProfileId** | **string** | The device profile ID of the device instance. | [optional] -**ExternalId** | **string** | The external ID that was set during install of a device. | [optional] -**Commands** | [**List<DeviceCommandsEventCommand>**](DeviceCommandsEventCommand.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceCommandsEventCommand.md b/docs/DeviceCommandsEventCommand.md deleted file mode 100644 index 58eb105..0000000 --- a/docs/DeviceCommandsEventCommand.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.DeviceCommandsEventCommand -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ComponentId** | **string** | | [optional] -**Capability** | **string** | | [optional] -**Command** | **string** | | [optional] -**Arguments** | **List<Object>** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceCommandsRequest.md b/docs/DeviceCommandsRequest.md deleted file mode 100644 index 8044cfa..0000000 --- a/docs/DeviceCommandsRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.DeviceCommandsRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Commands** | [**List<DeviceCommand>**](DeviceCommand.md) | An array of commands to execute on the Device. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceComponent.md b/docs/DeviceComponent.md deleted file mode 100644 index edaa77d..0000000 --- a/docs/DeviceComponent.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.DeviceComponent -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | | [optional] -**Label** | **string** | UTF-8 label for the component. | [optional] -**Capabilities** | [**List<CapabilityReference>**](CapabilityReference.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceComponentReference.md b/docs/DeviceComponentReference.md deleted file mode 100644 index 2f8644a..0000000 --- a/docs/DeviceComponentReference.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.DeviceComponentReference -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | | -**Capabilities** | [**List<CapabilityReference>**](CapabilityReference.md) | A list of `[ 1..20 ]` capabilities for this component. | -**Categories** | [**List<DeviceCategory>**](DeviceCategory.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceConfig.md b/docs/DeviceConfig.md deleted file mode 100644 index d9c81cc..0000000 --- a/docs/DeviceConfig.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.DeviceConfig -A device and component configuration with any required permissions. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceId** | **string** | The ID of the device. | [optional] -**ComponentId** | **string** | The component ID on the device. | [optional] -**Permissions** | **List<string>** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceEvent.md b/docs/DeviceEvent.md deleted file mode 100644 index 512bcf0..0000000 --- a/docs/DeviceEvent.md +++ /dev/null @@ -1,20 +0,0 @@ -# SmartThingsNet.Model.DeviceEvent -An event on a device that matched a subscription for this app. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EventId** | **string** | The ID of the event. | [optional] -**LocationId** | **string** | The ID of the location in which the event was triggered. | [optional] -**DeviceId** | **string** | The ID of the device associated with the DEVICE_EVENT. | [optional] -**ComponentId** | **string** | The name of the component on the device that the event is associated with. | [optional] -**Capability** | **string** | The name of the capability associated with the DEVICE_EVENT. | [optional] -**Attribute** | **string** | The name of the DEVICE_EVENT. This typically corresponds to an attribute name of the device-handler’s capabilities. | [optional] -**Value** | **Object** | The value of the event. The type of the value is dependent on the capability's attribute type. | [optional] -**ValueType** | **string** | The root level data type of the value field. The data types are representitive of standard JSON data types. | [optional] -**StateChange** | **bool** | Whether or not the state of the device has changed as a result of the DEVICE_EVENT. | [optional] -**Data** | **Object** | json map as defined by capability data schema | [optional] -**SubscriptionName** | **string** | The name of subscription that caused delivery. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceEventsRequest.md b/docs/DeviceEventsRequest.md deleted file mode 100644 index 5ebbb63..0000000 --- a/docs/DeviceEventsRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.DeviceEventsRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceEvents** | [**List<DeviceStateEvent>**](DeviceStateEvent.md) | An array of attribute state updates. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceHealthDetail.md b/docs/DeviceHealthDetail.md deleted file mode 100644 index b6d241d..0000000 --- a/docs/DeviceHealthDetail.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.DeviceHealthDetail -Details of a subscription of source type DEVICE_HEALTH. Only one of deviceIds or locationId should be supplied. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceIds** | **List<string>** | An array of GUIDs of devices being subscribed to. A max of 20 GUIDs are allowed. | [optional] -**SubscriptionName** | **string** | A name for the subscription that will be passed to the installed app. | [optional] -**LocationId** | **string** | The id of the location that both the app and source device are in. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceHealthEvent.md b/docs/DeviceHealthEvent.md deleted file mode 100644 index 7113a30..0000000 --- a/docs/DeviceHealthEvent.md +++ /dev/null @@ -1,15 +0,0 @@ -# SmartThingsNet.Model.DeviceHealthEvent -An event that represents a change in the health of the a device. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EventId** | **string** | The id of the event. | [optional] -**LocationId** | **string** | The id of the location in which the event was triggered. | [optional] -**DeviceId** | **string** | The id of the device. | [optional] -**HubId** | **string** | The id of the hub. | [optional] -**Status** | **string** | The status of the device. | [optional] -**Reason** | **string** | The reason the device is offline. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceInstallRequest.md b/docs/DeviceInstallRequest.md deleted file mode 100644 index 55b2727..0000000 --- a/docs/DeviceInstallRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.DeviceInstallRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Label** | **string** | The label for the device. | [optional] -**LocationId** | **string** | The ID of the Location with which the device is associated. | -**App** | [**DeviceInstallRequestApp**](DeviceInstallRequestApp.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceInstallRequestApp.md b/docs/DeviceInstallRequestApp.md deleted file mode 100644 index a132ca0..0000000 --- a/docs/DeviceInstallRequestApp.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.DeviceInstallRequestApp -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ProfileId** | **string** | The device profile Id | -**InstalledAppId** | **string** | The ID of the installed application | -**ExternalId** | **string** | A field to store an ID from a system external to SmartThings. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceIntegrationType.md b/docs/DeviceIntegrationType.md deleted file mode 100644 index 91cd318..0000000 --- a/docs/DeviceIntegrationType.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.DeviceIntegrationType -The type of device integration (may be null). If the type is DTH, the device implementation is a groovy Device Handler and the details are in the \"dth\" field. If the type is ENDPOINT_APP, the device implementation is a SmartApp and the details are in the \"app\" field. If the type is IR, the details are in the \"ir\" field. If the type is IR_OCF, the details are in the \"irOcf\" field. If the type is VIPER, the details are in the \"viper\" field. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceLifecycle.md b/docs/DeviceLifecycle.md deleted file mode 100644 index abf62fe..0000000 --- a/docs/DeviceLifecycle.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.DeviceLifecycle -The device lifecycle. The lifecycle will be one of: * CREATE - Invoked when a device is created. * DELETE - Invoked when a device is deleted. * UPDATE - Invoked when a device is updated. * MOVE_FROM - Invoked when a device is moved from a location. * MOVE_TO - Invoked when a device is moved to a location. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceLifecycleDetail.md b/docs/DeviceLifecycleDetail.md deleted file mode 100644 index 6a6dc66..0000000 --- a/docs/DeviceLifecycleDetail.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.DeviceLifecycleDetail -Details of a subscription of source type DEVICE_LIFECYCLE. Only one of deviceIds or locationId should be supplied. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceIds** | **List<string>** | An array of GUIDs of devices being subscribed to. A max of 20 GUIDs are allowed. | [optional] -**SubscriptionName** | **string** | A name for the subscription that will be passed to the installed app. | [optional] -**LocationId** | **string** | The id of the location that both the app and source device are in. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceLifecycleEvent.md b/docs/DeviceLifecycleEvent.md deleted file mode 100644 index 38cb637..0000000 --- a/docs/DeviceLifecycleEvent.md +++ /dev/null @@ -1,20 +0,0 @@ -# SmartThingsNet.Model.DeviceLifecycleEvent -A device lifecycle event. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Lifecycle** | **DeviceLifecycle** | | [optional] -**EventId** | **string** | The id of the event. | [optional] -**LocationId** | **string** | The id of the location in which the event was triggered. | [optional] -**DeviceId** | **string** | The id of the device. | [optional] -**DeviceName** | **string** | The name of the device | [optional] -**Principal** | **string** | The principal that made the change | [optional] -**Create** | **Object** | Create device lifecycle. | [optional] -**Delete** | **Object** | Delete device lifecycle. | [optional] -**Update** | **Object** | Update device lifecycle. | [optional] -**MoveFrom** | [**DeviceLifecycleMove**](DeviceLifecycleMove.md) | | [optional] -**MoveTo** | [**DeviceLifecycleMove**](DeviceLifecycleMove.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceLifecycleMove.md b/docs/DeviceLifecycleMove.md deleted file mode 100644 index 70f35f9..0000000 --- a/docs/DeviceLifecycleMove.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.DeviceLifecycleMove -Move device lifecycle. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LocationId** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceNetworkSecurityLevel.md b/docs/DeviceNetworkSecurityLevel.md deleted file mode 100644 index 17457b3..0000000 --- a/docs/DeviceNetworkSecurityLevel.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.DeviceNetworkSecurityLevel -For hub-connected devices on protocols with multiple security levels, the security level the device was added with. Values ZWAVE_S2_FAILED, ZWAVE_S0_FAILED, ZWAVE_S2_DOWNGRADE, and ZWAVE_S0_DOWNGRADE should be treated as failures and prompt the user to remove and re-add the device. Other Z-Wave values are success cases. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceOperand.md b/docs/DeviceOperand.md deleted file mode 100644 index c2b7a5d..0000000 --- a/docs/DeviceOperand.md +++ /dev/null @@ -1,15 +0,0 @@ -# SmartThingsNet.Model.DeviceOperand -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Devices** | **List<string>** | | [optional] -**Component** | **string** | | -**Capability** | **string** | | -**Attribute** | **string** | | -**Path** | **string** | | [optional] -**Aggregation** | **OperandAggregationMode** | | [optional] -**SubscriptionMode** | **SubscriptionMode** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceProfile.md b/docs/DeviceProfile.md deleted file mode 100644 index 35c6395..0000000 --- a/docs/DeviceProfile.md +++ /dev/null @@ -1,14 +0,0 @@ -# SmartThingsNet.Model.DeviceProfile -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | | [optional] -**Name** | **string** | | [optional] -**Owner** | [**Owner**](Owner.md) | | [optional] -**Components** | [**List<DeviceComponent>**](DeviceComponent.md) | | [optional] -**Metadata** | **Dictionary<string, string>** | Additional information about the device profile, limited to 10 entries. | [optional] -**Status** | **DeviceProfileStatus** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceProfileReference.md b/docs/DeviceProfileReference.md deleted file mode 100644 index 46b57b2..0000000 --- a/docs/DeviceProfileReference.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.DeviceProfileReference -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | The device profile Id | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceProfileStatus.md b/docs/DeviceProfileStatus.md deleted file mode 100644 index 9368946..0000000 --- a/docs/DeviceProfileStatus.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.DeviceProfileStatus -The lifecycle status of a device profile. 'DEVELOPMENT' - Device profile can be modified. The profile is only available to the developer and can only be used with a self-published app. 'PUBLISHED' - Device profile can be shared with other users, but cannot be modified. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceResults.md b/docs/DeviceResults.md deleted file mode 100644 index 112e0d4..0000000 --- a/docs/DeviceResults.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.DeviceResults -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceId** | **string** | deviceId created by DM | [optional] -**Name** | **string** | initial device name from the partner | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceStateEvent.md b/docs/DeviceStateEvent.md deleted file mode 100644 index f974069..0000000 --- a/docs/DeviceStateEvent.md +++ /dev/null @@ -1,14 +0,0 @@ -# SmartThingsNet.Model.DeviceStateEvent -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Component** | **string** | The name of the component on this device, default is 'main'. | [optional] -**Capability** | **string** | Capability that this event relates to. | [optional] -**Attribute** | **string** | Name of the capability attribute that this event relates to. | [optional] -**Value** | **Object** | Value associated with the event. The valid value depends on the capability. | -**Unit** | **string** | Unit of the value field. | [optional] -**Data** | **Dictionary<string, Object>** | Key value pairs about the state of the device. Valid values depend on the capability. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceStatus.md b/docs/DeviceStatus.md deleted file mode 100644 index c7d64cb..0000000 --- a/docs/DeviceStatus.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.DeviceStatus -The status of a Device. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Components** | **Dictionary<string, Dictionary>** | A map of componentId to Component status. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceSubscriptionDetail.md b/docs/DeviceSubscriptionDetail.md deleted file mode 100644 index b2a1ca8..0000000 --- a/docs/DeviceSubscriptionDetail.md +++ /dev/null @@ -1,17 +0,0 @@ -# SmartThingsNet.Model.DeviceSubscriptionDetail -Details of a subscription of source type DEVICE. The combination of subscribed values must be unique per installed app. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceId** | **string** | The GUID of the device that is subscribed to. | -**ComponentId** | **string** | The component ID on the device that is subscribed to or * for all. | [optional] [default to "*"] -**Capability** | **string** | Name of the capability that is subscribed to or * for all. | [optional] [default to "*"] -**Attribute** | **string** | Name of the capabilities attribute or * for all. | [optional] [default to "*"] -**Value** | **Object** | A particular value for the attribute that will trigger the subscription or * for all. | [optional] -**StateChangeOnly** | **bool** | Only execute the subscription if the subscribed event is a state change from previous events. | [optional] -**SubscriptionName** | **string** | A name for the subscription that will be passed to the installed app. Must be unique per installed app. | [optional] -**Modes** | **List<string>** | List of mode ID's that the subscription will execute for. If not provided then all modes will be supported. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceprofilesApi.md b/docs/DeviceprofilesApi.md deleted file mode 100644 index 994c2ce..0000000 --- a/docs/DeviceprofilesApi.md +++ /dev/null @@ -1,428 +0,0 @@ -# SmartThingsNet.Api.DeviceprofilesApi - -All URIs are relative to _https://api.smartthings.com/v1_ - -| Method | HTTP request | Description | -| ------------------------------------------------------------------- | -------------------------------------------- | --------------------------------------------------- | -| [**CreateDeviceProfile**](DeviceprofilesApi.md#createdeviceprofile) | **POST** /deviceprofiles | Create a device profile | -| [**DeleteDeviceProfile**](DeviceprofilesApi.md#deletedeviceprofile) | **DELETE** /deviceprofiles/{deviceProfileId} | Delete a device profile | -| [**GetDeviceProfile**](DeviceprofilesApi.md#getdeviceprofile) | **GET** /deviceprofiles/{deviceProfileId} | GET a device profile | -| [**ListDeviceProfiles**](DeviceprofilesApi.md#listdeviceprofiles) | **GET** /deviceprofiles | List all device profiles for the authenticated user | -| [**UpdateDeviceProfile**](DeviceprofilesApi.md#updatedeviceprofile) | **PUT** /deviceprofiles/{deviceProfileId} | Update a device profile. | - - - -# **CreateDeviceProfile** - -> DeviceProfile CreateDeviceProfile (CreateDeviceProfileRequest request = null) - -Create a device profile - -Create a device profile. - -### Example - -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class CreateDeviceProfileExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DeviceprofilesApi(config); - var request = new CreateDeviceProfileRequest(); // CreateDeviceProfileRequest | The device profile to be created. (optional) - - try - { - // Create a device profile - DeviceProfile result = apiInstance.CreateDeviceProfile(request); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DeviceprofilesApi.CreateDeviceProfile: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ----------------- | --------------------------------------------------------------- | --------------------------------- | ---------- | -| **request** | [**CreateDeviceProfileRequest**](CreateDeviceProfileRequest.md) | The device profile to be created. | [optional] | - -### Return type - -[**DeviceProfile**](DeviceProfile.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------- | ---------------- | -| **200** | The device profile. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - - -# **DeleteDeviceProfile** - -> Object DeleteDeviceProfile (string deviceProfileId) - -Delete a device profile - -Delete a device profile by ID. Admin use only. - -### Example - -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class DeleteDeviceProfileExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DeviceprofilesApi(config); - var deviceProfileId = deviceProfileId_example; // string | the device profile ID - - try - { - // Delete a device profile - Object result = apiInstance.DeleteDeviceProfile(deviceProfileId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DeviceprofilesApi.DeleteDeviceProfile: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------------- | ---------- | --------------------- | ----- | -| **authorization** | **string** | OAuth token | -| **deviceProfileId** | **string** | the device profile ID | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ----------------------- | ---------------- | -| **200** | Device profile deleted. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - - -# **GetDeviceProfile** - -> DeviceProfile GetDeviceProfile (string deviceProfileId, string acceptLanguage = null) - -GET a device profile - -GET a device profile. - -### Example - -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetDeviceProfileExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DeviceprofilesApi(config); - var deviceProfileId = deviceProfileId_example; // string | the device profile ID - var acceptLanguage = acceptLanguage_example; // string | Language header representing the client's preferred language. The format of the `Accept-Language` header follows what is defined in [RFC 7231, section 5.3.5](https://tools.ietf.org/html/rfc7231#section-5.3.5) (optional) - - try - { - // GET a device profile - DeviceProfile result = apiInstance.GetDeviceProfile(deviceProfileId, acceptLanguage); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DeviceprofilesApi.GetDeviceProfile: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | -| **authorization** | **string** | OAuth token | -| **deviceProfileId** | **string** | the device profile ID | -| **acceptLanguage** | **string** | Language header representing the client's preferred language. The format of the `Accept-Language` header follows what is defined in [RFC 7231, section 5.3.5](https://tools.ietf.org/html/rfc7231#section-5.3.5) | [optional] | - -### Return type - -[**DeviceProfile**](DeviceProfile.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **200** | A Device Profile | \* Content-Language - This header field describes the natural language(s) of the intended audience for the representation. This can have multiple values as per [RFC 7231, section 3.1.3.2](https://tools.ietf.org/html/rfc7231#section-3.1.3.2)
| -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - - -# **ListDeviceProfiles** - -> PagedDeviceProfiles ListDeviceProfiles (List profileId = null) - -List all device profiles for the authenticated user - -List device profiles. - -### Example - -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ListDeviceProfilesExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DeviceprofilesApi(config); - var profileId = new List(); // List | The device profiles IDs to filter the results by. (optional) - - try - { - // List all device profiles for the authenticated user - PagedDeviceProfiles result = apiInstance.ListDeviceProfiles(profileId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DeviceprofilesApi.ListDeviceProfiles: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ----------------- | ----------------------------------- | ------------------------------------------------- | ---------- | -| **authorization** | **string** | OAuth token | -| **profileId** | [**List<string>**](string.md) | The device profiles IDs to filter the results by. | [optional] | - -### Return type - -[**PagedDeviceProfiles**](PagedDeviceProfiles.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------ | ---------------- | -| **200** | A list of the users device profiles. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - - -# **UpdateDeviceProfile** - -> DeviceProfile UpdateDeviceProfile (string deviceProfileId, UpdateDeviceProfileRequest request = null) - -Update a device profile. - -Update a device profile. The device profile has to be in development status - -### Example - -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class UpdateDeviceProfileExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DeviceprofilesApi(config); - var deviceProfileId = deviceProfileId_example; // string | the device profile ID - var request = new UpdateDeviceProfileRequest(); // UpdateDeviceProfileRequest | The device profile to be updated. (optional) - - try - { - // Update a device profile. - DeviceProfile result = apiInstance.UpdateDeviceProfile(deviceProfileId, request); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DeviceprofilesApi.UpdateDeviceProfile: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------------- | --------------------------------------------------------------- | --------------------------------- | ---------- | -| **deviceProfileId** | **string** | the device profile ID | -| **request** | [**UpdateDeviceProfileRequest**](UpdateDeviceProfileRequest.md) | The device profile to be updated. | [optional] | - -### Return type - -[**DeviceProfile**](DeviceProfile.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------ | ---------------- | -| **200** | The device profile | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/DevicesApi.md b/docs/DevicesApi.md deleted file mode 100644 index 96796a1..0000000 --- a/docs/DevicesApi.md +++ /dev/null @@ -1,840 +0,0 @@ -# SmartThingsNet.Api.DevicesApi - -All URIs are relative to *https://api.smartthings.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateDeviceEvents**](DevicesApi.md#createdeviceevents) | **POST** /devices/{deviceId}/events | Create Device Events. -[**DeleteDevice**](DevicesApi.md#deletedevice) | **DELETE** /devices/{deviceId} | Delete a Device. -[**ExecuteDeviceCommands**](DevicesApi.md#executedevicecommands) | **POST** /devices/{deviceId}/commands | Execute commands on device. -[**GetDevice**](DevicesApi.md#getdevice) | **GET** /devices/{deviceId} | Get a device's description. -[**GetDeviceComponentStatus**](DevicesApi.md#getdevicecomponentstatus) | **GET** /devices/{deviceId}/components/{componentId}/status | Get a device component's status. -[**GetDeviceStatus**](DevicesApi.md#getdevicestatus) | **GET** /devices/{deviceId}/status | Get the full status of a device. -[**GetDeviceStatusByCapability**](DevicesApi.md#getdevicestatusbycapability) | **GET** /devices/{deviceId}/components/{componentId}/capabilities/{capabilityId}/status | Get a capability's status. -[**GetDevices**](DevicesApi.md#getdevices) | **GET** /devices | List devices. -[**InstallDevice**](DevicesApi.md#installdevice) | **POST** /devices | Install a Device. -[**UpdateDevice**](DevicesApi.md#updatedevice) | **PUT** /devices/{deviceId} | Update a device. - - - -# **CreateDeviceEvents** -> Object CreateDeviceEvents (string deviceId, DeviceEventsRequest deviceEventRequest) - -Create Device Events. - -Create events for a device. When a device is managed by a SmartApp then it is responsible for creating events to update the attributes of the device in the SmartThings platform. The token must be for a SmartApp and it must be the SmartApp that created the Device. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class CreateDeviceEventsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DevicesApi(config); - - var deviceId = deviceId_example; // string | the device ID - var deviceEventRequest = new DeviceEventsRequest(); // DeviceEventsRequest | - - try - { - // Create Device Events. - Object result = apiInstance.CreateDeviceEvents(deviceId, deviceEventRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DevicesApi.CreateDeviceEvents: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **deviceId** | **string**| the device ID | - **deviceEventRequest** | [**DeviceEventsRequest**](DeviceEventsRequest.md)| | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Created events. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **DeleteDevice** -> Object DeleteDevice (string deviceId) - -Delete a Device. - -Delete a device by device id. If the token is for a SmartApp that created the device then it implicitly has permission for this api. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class DeleteDeviceExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DevicesApi(config); - - var deviceId = deviceId_example; // string | the device ID - - try - { - // Delete a Device. - Object result = apiInstance.DeleteDevice(deviceId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DevicesApi.DeleteDevice: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **deviceId** | **string**| the device ID | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Device deleted. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **ExecuteDeviceCommands** -> Object ExecuteDeviceCommands (string deviceId, DeviceCommandsRequest executeCapabilityCommand) - -Execute commands on device. - -Execute commands on a device. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ExecuteDeviceCommandsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DevicesApi(config); - - var deviceId = deviceId_example; // string | the device ID - var executeCapabilityCommand = new DeviceCommandsRequest(); // DeviceCommandsRequest | - - try - { - // Execute commands on device. - Object result = apiInstance.ExecuteDeviceCommands(deviceId, executeCapabilityCommand); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DevicesApi.ExecuteDeviceCommands: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **deviceId** | **string**| the device ID | - **executeCapabilityCommand** | [**DeviceCommandsRequest**](DeviceCommandsRequest.md)| | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Created commands. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetDevice** -> Device GetDevice (string deviceId) - -Get a device's description. - -Get a device's description. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetDeviceExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DevicesApi(config); - - var deviceId = deviceId_example; // string | the device ID - - try - { - // Get a device's description. - Device result = apiInstance.GetDevice(deviceId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DevicesApi.GetDevice: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **deviceId** | **string**| the device ID | - -### Return type - -[**Device**](Device.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | A Device | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetDeviceComponentStatus** -> Dictionary<string, Dictionary> GetDeviceComponentStatus (string deviceId, string componentId) - -Get a device component's status. - -Get the status of all attributes of a the component. The results may be filtered if the requester only has permission to view a subset of the component's capabilities. If the token is for a SmartApp that created the device then it implicitly has permission for this api. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetDeviceComponentStatusExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DevicesApi(config); - - var deviceId = deviceId_example; // string | the device ID - var componentId = componentId_example; // string | The name of the component. - - try - { - // Get a device component's status. - Dictionary result = apiInstance.GetDeviceComponentStatus(deviceId, componentId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DevicesApi.GetDeviceComponentStatus: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **deviceId** | **string**| the device ID | - **componentId** | **string**| The name of the component. | - -### Return type - -**Dictionary** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful return current status of device component's attributes. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetDeviceStatus** -> DeviceStatus GetDeviceStatus (string deviceId) - -Get the full status of a device. - -Get the current status of all of a device's component's attributes. The results may be filtered if the requester only has permission to view a subset of the device's components or capabilities. If the token is for a SmartApp that created the device then it implicitly has permission for this api. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetDeviceStatusExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DevicesApi(config); - - var deviceId = deviceId_example; // string | the device ID - - try - { - // Get the full status of a device. - DeviceStatus result = apiInstance.GetDeviceStatus(deviceId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DevicesApi.GetDeviceStatus: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **deviceId** | **string**| the device ID | - -### Return type - -[**DeviceStatus**](DeviceStatus.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | successful return of current status of device attributes | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetDeviceStatusByCapability** -> Dictionary<string, AttributeState> GetDeviceStatusByCapability (string deviceId, string componentId, string capabilityId) - -Get a capability's status. - -Get the current status of a device component's capability. If the token is for a SmartApp that created the device then it implicitly has permission for this api. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetDeviceStatusByCapabilityExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DevicesApi(config); - - var deviceId = deviceId_example; // string | the device ID - var componentId = componentId_example; // string | The name of the component. - var capabilityId = capabilityId_example; // string | The ID of the capability - - try - { - // Get a capability's status. - Dictionary result = apiInstance.GetDeviceStatusByCapability(deviceId, componentId, capabilityId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DevicesApi.GetDeviceStatusByCapability: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **deviceId** | **string**| the device ID | - **componentId** | **string**| The name of the component. | - **capabilityId** | **string**| The ID of the capability | - -### Return type - -[**Dictionary<string, AttributeState>**](AttributeState.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful return of current status of the attributes of a device component's capability | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetDevices** -> PagedDevices GetDevices (List capability = null, List locationId = null, List deviceId = null, string capabilitiesMode = null) - -List devices. - -Get a list of devices. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetDevicesExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DevicesApi(config); - - var capability = new List(); // List | The device capabilities to filter the results by. The capabilities are treated as an \"and\" so all capabilities must be present. (optional) - var locationId = new List(); // List | The device locations to filter the results by. (optional) - var deviceId = new List(); // List | The device ids to filter the results by. (optional) - var capabilitiesMode = capabilitiesMode_example; // string | Treat all capability filter query params as a logical \"or\" or \"and\" with a default of \"and\". (optional) (default to and) - - try - { - // List devices. - PagedDevices result = apiInstance.GetDevices(capability, locationId, deviceId, capabilitiesMode); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DevicesApi.GetDevices: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **capability** | [**List<string>**](string.md)| The device capabilities to filter the results by. The capabilities are treated as an \"and\" so all capabilities must be present. | [optional] - **locationId** | [**List<string>**](string.md)| The device locations to filter the results by. | [optional] - **deviceId** | [**List<string>**](string.md)| The device ids to filter the results by. | [optional] - **capabilitiesMode** | **string**| Treat all capability filter query params as a logical \"or\" or \"and\" with a default of \"and\". | [optional] [default to and] - -### Return type - -[**PagedDevices**](PagedDevices.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | A list of devices. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **InstallDevice** -> Device InstallDevice (DeviceInstallRequest installationRequest) - -Install a Device. - -Install a device. This is only available for SmartApp managed devices. The SmartApp that creates the device is responsible for handling commands for the device and updating the status of the device by creating events. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class InstallDeviceExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DevicesApi(config); - - var installationRequest = new DeviceInstallRequest(); // DeviceInstallRequest | Installation Request - - try - { - // Install a Device. - Device result = apiInstance.InstallDevice(installationRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DevicesApi.InstallDevice: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **installationRequest** | [**DeviceInstallRequest**](DeviceInstallRequest.md)| Installation Request | - -### Return type - -[**Device**](Device.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Device Installed. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **UpdateDevice** -> Device UpdateDevice (string deviceId, UpdateDeviceRequest updateDeviceRequest) - -Update a device. - -Update the properties of a device. If the token is for a SmartApp that created the device then it implicitly has permission for this api. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class UpdateDeviceExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new DevicesApi(config); - - var deviceId = deviceId_example; // string | the device ID - var updateDeviceRequest = new UpdateDeviceRequest(); // UpdateDeviceRequest | - - try - { - // Update a device. - Device result = apiInstance.UpdateDevice(deviceId, updateDeviceRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling DevicesApi.UpdateDevice: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **deviceId** | **string**| the device ID | - **updateDeviceRequest** | [**UpdateDeviceRequest**](UpdateDeviceRequest.md)| | - -### Return type - -[**Device**](Device.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Updated Device. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/DthDeviceDetails.md b/docs/DthDeviceDetails.md deleted file mode 100644 index ff7c05c..0000000 --- a/docs/DthDeviceDetails.md +++ /dev/null @@ -1,14 +0,0 @@ -# SmartThingsNet.Model.DthDeviceDetails -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceTypeId** | **string** | The identifier for the device's DeviceType. | -**DeviceTypeName** | **string** | The name for the device's DeviceType. | -**DeviceNetworkType** | **string** | The device network type. | [optional] -**CompletedSetup** | **bool** | True if the device setup has been completed so the device is ready to use. | -**NetworkSecurityLevel** | **DeviceNetworkSecurityLevel** | | [optional] -**HubId** | **string** | The hub that the device is connected to. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EndpointApp.md b/docs/EndpointApp.md deleted file mode 100644 index 363176d..0000000 --- a/docs/EndpointApp.md +++ /dev/null @@ -1,28 +0,0 @@ -# SmartThingsNet.Model.EndpointApp -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AppName** | **string** | The name of the endpoint app | [optional] -**PartnerName** | **string** | The name of the partner/brand | [optional] -**OAuthAuthorizationUrl** | **string** | oAuth authorization url of the partner | [optional] -**LambdaArn** | **string** | lambda arn of the partner for US region (default) | [optional] -**LambdaArnEU** | **string** | lambda arn of the partner for EU region | [optional] -**LambdaArnAP** | **string** | lambda arn of the partner for AP region | [optional] -**LambdaArnCN** | **string** | lambda arn of the partner for CN region | [optional] -**Icon** | **string** | url of partner icon | [optional] -**Icon2x** | **string** | url of partner icon in 2x dimensions | [optional] -**Icon3x** | **string** | url of partner icon in 3x dimensions | [optional] -**EndpointAppId** | **string** | Viper endpoint app id for the partner | [optional] -**OAuthClientId** | **string** | Client id for the partner oAuth | [optional] -**OAuthClientSecret** | **string** | Client secret for the partner oAuth | [optional] -**OAuthTokenUrl** | **string** | oAuth token refresh url of the partner | [optional] -**OAuthScope** | **string** | oAuth scope for the partner. Example \"remote_control:all\" for Lifx | [optional] -**UserId** | **string** | user id for the partner | [optional] -**HostingType** | **string** | Possible values - \"lambda\" or \"webhook\" | [optional] -**SchemaType** | **string** | Possible values - \"alexa-schema\", \"st-schema\", \"google-schema\" | [optional] -**WebhookUrl** | **string** | webhook url for the partner | [optional] -**CertificationStatus** | **string** | Possible values - \"\", \"cst\", \"wwst\" | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EqualsCondition.md b/docs/EqualsCondition.md deleted file mode 100644 index 79f884f..0000000 --- a/docs/EqualsCondition.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.EqualsCondition -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the condition | [optional] -**Left** | [**Operand**](Operand.md) | | -**Right** | [**Operand**](Operand.md) | | -**Aggregation** | [**ConditionAggregationMode**](ConditionAggregationMode.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Error.md b/docs/Error.md deleted file mode 100644 index dc439bd..0000000 --- a/docs/Error.md +++ /dev/null @@ -1,13 +0,0 @@ -# SmartThingsNet.Model.Error -Details about the error. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Code** | **string** | Machine readable error code. | [optional] -**Message** | **string** | Human readable error message. | [optional] -**Target** | **string** | Optional field used to point to a problamatic part of the request. | [optional] -**Details** | [**List<Error>**](Error.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ErrorResponse.md b/docs/ErrorResponse.md deleted file mode 100644 index c4a554b..0000000 --- a/docs/ErrorResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.ErrorResponse -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | **string** | A correlation id used for reference when contacting support. | [optional] -**Error** | [**Error**](Error.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EventType.md b/docs/EventType.md deleted file mode 100644 index 9681df4..0000000 --- a/docs/EventType.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.EventType -The type of event passed to the app being executed. The type will be one of: * DEVICE_COMMANDS_EVENT - _Only applicable for cloud-to-cloud device integration apps._ An event as a result of a device command execution request. * DEVICE_EVENT - A device event as a result of a subscription the app created. * DEVICE_HEALTH_EVENT - A device health event as a result of a change in a device's health. * DEVICE_LIFECYCLE_EVENT - A device lifecycle event as the result of a life change to the device. * HUB_HEALTH_EVENT - A hub health event as a result of a change in a hub's health. * MODE_EVENT - A mode event is triggered when the location's mode is changed. * SCENE_LIFECYCLE_EVENT - A scene lifecycle event as a result of a life change to the scene. * SECURITY_ARM_STATE_EVENT - A security arm state event as a result of a change in the arm state of a security system. * TIMER_EVENT - An event as a result of a scheduled app execution. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EveryAction.md b/docs/EveryAction.md deleted file mode 100644 index 487d217..0000000 --- a/docs/EveryAction.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.EveryAction -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the action | [optional] -**Interval** | [**Interval**](Interval.md) | | [optional] -**Specific** | [**TimeOperand**](TimeOperand.md) | | [optional] -**Actions** | [**List<Action>**](Action.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ExecutionResult.md b/docs/ExecutionResult.md deleted file mode 100644 index e6cbeda..0000000 --- a/docs/ExecutionResult.md +++ /dev/null @@ -1,8 +0,0 @@ -# SmartThingsNet.Model.ExecutionResult -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/GenerateAppOAuthRequest.md b/docs/GenerateAppOAuthRequest.md deleted file mode 100644 index 525b981..0000000 --- a/docs/GenerateAppOAuthRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.GenerateAppOAuthRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ClientName** | **string** | A name given to the OAuth Client. | [optional] -**Scope** | **List<string>** | A list of SmartThings API OAuth scope identifiers that maybe required to execute your integration. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/GenerateAppOAuthResponse.md b/docs/GenerateAppOAuthResponse.md deleted file mode 100644 index 44dfc04..0000000 --- a/docs/GenerateAppOAuthResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.GenerateAppOAuthResponse -A response object containing a new OAuth Client and it's details. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**OauthClientDetails** | [**AppOAuth**](AppOAuth.md) | | [optional] -**OauthClientId** | **Guid** | The OAuth Client ID. | [optional] -**OauthClientSecret** | **Guid** | The OAuth Client Secret. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/GetAppSettingsResponse.md b/docs/GetAppSettingsResponse.md deleted file mode 100644 index 94af6c8..0000000 --- a/docs/GetAppSettingsResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.GetAppSettingsResponse -Settings for a given app -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Settings** | **Dictionary<string, string>** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/GreaterThanCondition.md b/docs/GreaterThanCondition.md deleted file mode 100644 index 020a3ab..0000000 --- a/docs/GreaterThanCondition.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.GreaterThanCondition -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the condition | [optional] -**Left** | [**Operand**](Operand.md) | | -**Right** | [**Operand**](Operand.md) | | -**Aggregation** | [**ConditionAggregationMode**](ConditionAggregationMode.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/GreaterThanOrEqualsCondition.md b/docs/GreaterThanOrEqualsCondition.md deleted file mode 100644 index 0917f3d..0000000 --- a/docs/GreaterThanOrEqualsCondition.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.GreaterThanOrEqualsCondition -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the condition | [optional] -**Left** | [**Operand**](Operand.md) | | -**Right** | [**Operand**](Operand.md) | | -**Aggregation** | [**ConditionAggregationMode**](ConditionAggregationMode.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/HubHealthDetail.md b/docs/HubHealthDetail.md deleted file mode 100644 index 605070a..0000000 --- a/docs/HubHealthDetail.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.HubHealthDetail -Details of a subscription of souce type HUB_HEALTH -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SubscriptionName** | **string** | A name for the subscription that will be passed to the installed app. | [optional] -**LocationId** | **string** | The id of the location that both the app and hubs are in | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/HubHealthEvent.md b/docs/HubHealthEvent.md deleted file mode 100644 index b3166b3..0000000 --- a/docs/HubHealthEvent.md +++ /dev/null @@ -1,14 +0,0 @@ -# SmartThingsNet.Model.HubHealthEvent -An event that represents a change in the health of a hub. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EventId** | **string** | The id of the event. | [optional] -**LocationId** | **string** | The id of the location in which the event was triggered. | [optional] -**HubId** | **string** | The id of the hub. | [optional] -**Status** | **string** | The status of the hub. | [optional] -**Reason** | **string** | The reason the hub is offline. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/IconImage.md b/docs/IconImage.md deleted file mode 100644 index d569f4b..0000000 --- a/docs/IconImage.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.IconImage -A default icon image for the app. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Url** | **string** | A default icon image url for an app. https url required. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/IfAction.md b/docs/IfAction.md deleted file mode 100644 index f6a55c3..0000000 --- a/docs/IfAction.md +++ /dev/null @@ -1,22 +0,0 @@ -# SmartThingsNet.Model.IfAction -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**And** | [**List<Condition>**](Condition.md) | | [optional] -**Or** | [**List<Condition>**](Condition.md) | | [optional] -**Not** | [**Condition**](Condition.md) | | [optional] -**Equals** | [**EqualsCondition**](EqualsCondition.md) | | [optional] -**GreaterThan** | [**GreaterThanCondition**](GreaterThanCondition.md) | | [optional] -**GreaterThanOrEquals** | [**GreaterThanOrEqualsCondition**](GreaterThanOrEqualsCondition.md) | | [optional] -**LessThan** | [**LessThanCondition**](LessThanCondition.md) | | [optional] -**LessThanOrEquals** | [**LessThanOrEqualsCondition**](LessThanOrEqualsCondition.md) | | [optional] -**Between** | [**BetweenCondition**](BetweenCondition.md) | | [optional] -**Changes** | [**ChangesCondition**](ChangesCondition.md) | | [optional] -**Id** | **string** | Unique id for the action | [optional] -**Then** | [**List<Action>**](Action.md) | | [optional] -**Else** | [**List<Action>**](Action.md) | | [optional] -**SubscriptionMode** | **SubscriptionMode** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/IfActionAllOf.md b/docs/IfActionAllOf.md deleted file mode 100644 index bf4a5d5..0000000 --- a/docs/IfActionAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.IfActionAllOf -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the action | [optional] -**Then** | [**List<Action>**](Action.md) | | [optional] -**Else** | [**List<Action>**](Action.md) | | [optional] -**SubscriptionMode** | **SubscriptionMode** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstallConfiguration.md b/docs/InstallConfiguration.md deleted file mode 100644 index e9302bf..0000000 --- a/docs/InstallConfiguration.md +++ /dev/null @@ -1,14 +0,0 @@ -# SmartThingsNet.Model.InstallConfiguration -An configuration instance of an Installed App. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**InstalledAppId** | **Guid** | The ID of the installed app. | [optional] -**ConfigurationId** | **Guid** | The ID to this configration instance. | [optional] -**ConfigurationStatus** | **InstallConfigurationStatus** | | [optional] -**CreatedDate** | **DateTime** | A UTC ISO-8601 Date-Time String | [optional] -**LastUpdatedDate** | **DateTime** | A UTC ISO-8601 Date-Time String | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstallConfigurationDetail.md b/docs/InstallConfigurationDetail.md deleted file mode 100644 index 843e138..0000000 --- a/docs/InstallConfigurationDetail.md +++ /dev/null @@ -1,15 +0,0 @@ -# SmartThingsNet.Model.InstallConfigurationDetail -Encompasses both a configuration value, and any required permissions that maybe needed. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**InstalledAppId** | **Guid** | The ID of the installed app. | [optional] -**ConfigurationId** | **Guid** | The ID to this configration instance. | [optional] -**ConfigurationStatus** | **InstallConfigurationStatus** | | [optional] -**Config** | **Dictionary<string, List>** | A multi-map of configurations for an Installed App. The map 'key' is the configuration name and the 'value' is an array of ConfigEntry models each containing a value and associated permissions. The config key is alpha-numeric, may contain dashes, underscores, periods, and must be less then 50 characters long. | [optional] -**CreatedDate** | **DateTime** | A UTC ISO-8601 Date-Time String | [optional] -**LastUpdatedDate** | **DateTime** | A UTC ISO-8601 Date-Time String | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstallConfigurationStatus.md b/docs/InstallConfigurationStatus.md deleted file mode 100644 index 15f3a4d..0000000 --- a/docs/InstallConfigurationStatus.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.InstallConfigurationStatus -Denotes the current state of a configuration instance. 'STAGED' configuration is used during active modification to config. A configuration is marked 'DONE' once it is deemed finished. At this point it is immutable, meaning it can't be changed. A status of 'AUTHORIZED' means the apps permissions have been authorized by the consumer. Installed Apps in 'AUTHORIZED' state are fully installed and used by the SmartThings platform. A status of 'REVOKED' means the apps permissions have been revoked. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstalledApp.md b/docs/InstalledApp.md deleted file mode 100644 index 885a8c3..0000000 --- a/docs/InstalledApp.md +++ /dev/null @@ -1,24 +0,0 @@ -# SmartThingsNet.Model.InstalledApp -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**InstalledAppId** | **Guid** | The ID of the installed app. | -**InstalledAppType** | **InstalledAppType** | | -**InstalledAppStatus** | **InstalledAppStatus** | | -**DisplayName** | **string** | A user defined name for the installed app. May be null. | [optional] -**AppId** | **string** | The ID of the app. | -**ReferenceId** | **string** | A reference to an upstream system. For example, Behaviors would reference the behaviorId. May be null. | [optional] -**LocationId** | **Guid** | The ID of the location to which the installed app may belong. | [optional] -**Owner** | [**Owner**](Owner.md) | | -**Notices** | [**List<Notice>**](Notice.md) | | -**CreatedDate** | **DateTime** | A UTC ISO-8601 Date-Time String | -**LastUpdatedDate** | **DateTime** | A UTC ISO-8601 Date-Time String | -**Ui** | [**InstalledAppUi**](InstalledAppUi.md) | | [optional] -**IconImage** | [**InstalledAppIconImage**](InstalledAppIconImage.md) | | [optional] -**Classifications** | **List<string>** | An App maybe associated to many classifications. A classification drives how the integration is presented to the user in the SmartThings mobile clients. These classifications include: * AUTOMATION - Denotes an integration that should display under the \"Automation\" tab in mobile clients. * SERVICE - Denotes an integration that is classified as a \"Service\". * DEVICE - Denotes an integration that should display under the \"Device\" tab in mobile clients. * CONNECTED_SERVICE - Denotes an integration that should display under the \"Connected Services\" menu in mobile clients. * HIDDEN - Denotes an integration that should not display in mobile clients | -**PrincipalType** | **string** | Denotes the principal type to be used with the app. Default is LOCATION. | -**SingleInstance** | **bool** | Inform the installation systems that the associated app can only be installed once within a user's account. | [default to false] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstalledAppIconImage.md b/docs/InstalledAppIconImage.md deleted file mode 100644 index 1414bff..0000000 --- a/docs/InstalledAppIconImage.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.InstalledAppIconImage -A default icon image for the app. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Url** | **string** | A default icon image url for an app. https url required. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstalledAppLifecycle.md b/docs/InstalledAppLifecycle.md deleted file mode 100644 index 70f9dd9..0000000 --- a/docs/InstalledAppLifecycle.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.InstalledAppLifecycle -The installed app lifecycle. The lifecycle will be one of: * CREATE - Invoked when an application is created. * INSTALL - Invoked when an application is installed. * UPDATE - Invoked when an application is updated. * DELETE - Invoked when an application is deleted. * OTHER - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstalledAppLifecycleError.md b/docs/InstalledAppLifecycleError.md deleted file mode 100644 index 8c7e555..0000000 --- a/docs/InstalledAppLifecycleError.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.InstalledAppLifecycleError -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Code** | **string** | | [optional] -**Message** | **string** | | [optional] -**Target** | **string** | | [optional] -**Details** | [**List<InstalledAppLifecycleError>**](InstalledAppLifecycleError.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstalledAppLifecycleEvent.md b/docs/InstalledAppLifecycleEvent.md deleted file mode 100644 index 9c7ecb3..0000000 --- a/docs/InstalledAppLifecycleEvent.md +++ /dev/null @@ -1,20 +0,0 @@ -# SmartThingsNet.Model.InstalledAppLifecycleEvent -An Installed App Lifecycle Event. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EventId** | **string** | The id of the event. | [optional] -**LocationId** | **string** | The ID of the location in which the event was triggered. | [optional] -**InstalledAppId** | **string** | The ID of the installed application. | [optional] -**AppId** | **string** | The ID of the application. | [optional] -**Lifecycle** | **InstalledAppLifecycle** | | [optional] -**Create** | **Object** | Create installed app lifecycle. | [optional] -**Install** | **Object** | Install installed app lifecycle. | [optional] -**Update** | **Object** | Update installed app lifecycle. | [optional] -**Delete** | **Object** | Delete installed app lifecycle. | [optional] -**Other** | **Object** | Other installed app lifecycle. | [optional] -**Error** | [**InstalledAppLifecycleError**](InstalledAppLifecycleError.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstalledAppStatus.md b/docs/InstalledAppStatus.md deleted file mode 100644 index 3dd3a3b..0000000 --- a/docs/InstalledAppStatus.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.InstalledAppStatus -Denotes the current state of an install. 'PENDING' is used during active modification to the install's config prior to 'AUTHORIZATION'. A status of 'AUTHORIZED' means the install's permissions have been authorized by the consumer. Installed Apps in 'AUTHORIZED' state are fully installed and usable by the SmartThings platform. A status of 'REVOKED' means the install's permissions have been revoked. A status of 'DISABLED' means a previously 'AUTHORIZED' Installed App will not execute. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstalledAppType.md b/docs/InstalledAppType.md deleted file mode 100644 index d9363c5..0000000 --- a/docs/InstalledAppType.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.InstalledAppType -Denotes the type of installed app. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstalledAppUi.md b/docs/InstalledAppUi.md deleted file mode 100644 index 2866f48..0000000 --- a/docs/InstalledAppUi.md +++ /dev/null @@ -1,13 +0,0 @@ -# SmartThingsNet.Model.InstalledAppUi -A collection of settings to drive user interface in SmartThings clients. Currently, only applicable for LAMBDA_SMART_APP and WEBHOOK_SMART_APP app types. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**PluginId** | **string** | | [optional] -**PluginUri** | **string** | | [optional] -**DashboardCardsEnabled** | **bool** | | -**PreInstallDashboardCardsEnabled** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstalledappsApi.md b/docs/InstalledappsApi.md deleted file mode 100644 index a1c61ba..0000000 --- a/docs/InstalledappsApi.md +++ /dev/null @@ -1,512 +0,0 @@ -# SmartThingsNet.Api.InstalledappsApi - -All URIs are relative to *https://api.smartthings.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateInstalledAppEvents**](InstalledappsApi.md#createinstalledappevents) | **POST** /installedapps/{installedAppId}/events | Create Installed App events. -[**DeleteInstallation**](InstalledappsApi.md#deleteinstallation) | **DELETE** /installedapps/{installedAppId} | Delete an installed app. -[**GetInstallation**](InstalledappsApi.md#getinstallation) | **GET** /installedapps/{installedAppId} | Get an installed app. -[**GetInstallationConfig**](InstalledappsApi.md#getinstallationconfig) | **GET** /installedapps/{installedAppId}/configs/{configurationId} | Get an installed app configuration. -[**ListInstallationConfig**](InstalledappsApi.md#listinstallationconfig) | **GET** /installedapps/{installedAppId}/configs | List an installed app's configurations. -[**ListInstallations**](InstalledappsApi.md#listinstallations) | **GET** /installedapps | List installed apps. - - - -# **CreateInstalledAppEvents** -> Object CreateInstalledAppEvents (string installedAppId, CreateInstalledAppEventsRequest createInstalledAppEventsRequest) - -Create Installed App events. - -Create events for an installed app. This API allows Apps to create events to trigger custom behavior in installed apps. Requires a SmartApp token. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class CreateInstalledAppEventsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new InstalledappsApi(config); - - var installedAppId = installedAppId_example; // string | The ID of the installed application. - var createInstalledAppEventsRequest = new CreateInstalledAppEventsRequest(); // CreateInstalledAppEventsRequest | - - try - { - // Create Installed App events. - Object result = apiInstance.CreateInstalledAppEvents(installedAppId, createInstalledAppEventsRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling InstalledappsApi.CreateInstalledAppEvents: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **installedAppId** | **string**| The ID of the installed application. | - **createInstalledAppEventsRequest** | [**CreateInstalledAppEventsRequest**](CreateInstalledAppEventsRequest.md)| | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Created events. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **DeleteInstallation** -> DeleteInstalledAppResponse DeleteInstallation (string installedAppId) - -Delete an installed app. - -Delete an Installed App. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class DeleteInstallationExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new InstalledappsApi(config); - - var installedAppId = installedAppId_example; // string | The ID of the installed application. - - try - { - // Delete an installed app. - DeleteInstalledAppResponse result = apiInstance.DeleteInstallation(installedAppId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling InstalledappsApi.DeleteInstallation: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **installedAppId** | **string**| The ID of the installed application. | - -### Return type - -[**DeleteInstalledAppResponse**](DeleteInstalledAppResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The number of installed apps deleted. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetInstallation** -> InstalledApp GetInstallation (string installedAppId) - -Get an installed app. - -Fetch a single installed application. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetInstallationExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new InstalledappsApi(config); - - var installedAppId = installedAppId_example; // string | The ID of the installed application. - - try - { - // Get an installed app. - InstalledApp result = apiInstance.GetInstallation(installedAppId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling InstalledappsApi.GetInstallation: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **installedAppId** | **string**| The ID of the installed application. | - -### Return type - -[**InstalledApp**](InstalledApp.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An installed app. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetInstallationConfig** -> InstallConfigurationDetail GetInstallationConfig (string installedAppId, Guid configurationId) - -Get an installed app configuration. - -Fetch a detailed install configuration model containing actual config entries / values. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetInstallationConfigExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new InstalledappsApi(config); - - var installedAppId = installedAppId_example; // string | The ID of the installed application. - var configurationId = new Guid(); // Guid | The ID of the install configuration. - - try - { - // Get an installed app configuration. - InstallConfigurationDetail result = apiInstance.GetInstallationConfig(installedAppId, configurationId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling InstalledappsApi.GetInstallationConfig: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **installedAppId** | **string**| The ID of the installed application. | - **configurationId** | [**Guid**](Guid.md)| The ID of the install configuration. | - -### Return type - -[**InstallConfigurationDetail**](InstallConfigurationDetail.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An install configuration detail model. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **ListInstallationConfig** -> PagedInstallConfigurations ListInstallationConfig (string installedAppId, string configurationStatus = null) - -List an installed app's configurations. - -List all configurations potentially filtered by status for an installed app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ListInstallationConfigExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new InstalledappsApi(config); - - var installedAppId = installedAppId_example; // string | The ID of the installed application. - var configurationStatus = configurationStatus_example; // string | Filter for configuration status. (optional) - - try - { - // List an installed app's configurations. - PagedInstallConfigurations result = apiInstance.ListInstallationConfig(installedAppId, configurationStatus); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling InstalledappsApi.ListInstallationConfig: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **installedAppId** | **string**| The ID of the installed application. | - **configurationStatus** | **string**| Filter for configuration status. | [optional] - -### Return type - -[**PagedInstallConfigurations**](PagedInstallConfigurations.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An paginated list of install configuration. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **ListInstallations** -> PagedInstalledApps ListInstallations (string locationId = null, string installedAppStatus = null, string installedAppType = null, string tag = null, string appId = null, string modeId = null, string deviceId = null) - -List installed apps. - -List all installed applications within the specified locations. If no locations are provided, then list all installed apps accessible by the principle. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ListInstallationsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new InstalledappsApi(config); - - var locationId = locationId_example; // string | The ID of the location that both the installed smart app and source are associated with. (optional) - var installedAppStatus = installedAppStatus_example; // string | State of the Installed App. (optional) - var installedAppType = installedAppType_example; // string | Denotes the type of installed app. (optional) - var tag = tag_example; // string | May be used to filter a resource by it's assigned user-tags. Multiple tag query params are automatically joined with OR. Example usage in query string: ``` ?tag:key_name=value1&tag:key_name=value2 ``` (optional) - var appId = appId_example; // string | The ID of an App (optional) - var modeId = modeId_example; // string | The ID of the mode (optional) - var deviceId = deviceId_example; // string | The ID of the device (optional) - - try - { - // List installed apps. - PagedInstalledApps result = apiInstance.ListInstallations(locationId, installedAppStatus, installedAppType, tag, appId, modeId, deviceId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling InstalledappsApi.ListInstallations: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The ID of the location that both the installed smart app and source are associated with. | [optional] - **installedAppStatus** | **string**| State of the Installed App. | [optional] - **installedAppType** | **string**| Denotes the type of installed app. | [optional] - **tag** | **string**| May be used to filter a resource by it's assigned user-tags. Multiple tag query params are automatically joined with OR. Example usage in query string: ``` ?tag:key_name=value1&tag:key_name=value2 ``` | [optional] - **appId** | **string**| The ID of an App | [optional] - **modeId** | **string**| The ID of the mode | [optional] - **deviceId** | **string**| The ID of the device | [optional] - -### Return type - -[**PagedInstalledApps**](PagedInstalledApps.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | A paginated list of installed apps. | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Interval.md b/docs/Interval.md deleted file mode 100644 index da727a6..0000000 --- a/docs/Interval.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.Interval -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | [**Operand**](Operand.md) | | -**Unit** | **IntervalUnit** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/IntervalUnit.md b/docs/IntervalUnit.md deleted file mode 100644 index 22c2fcb..0000000 --- a/docs/IntervalUnit.md +++ /dev/null @@ -1,8 +0,0 @@ -# SmartThingsNet.Model.IntervalUnit -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/IrDeviceDetails.md b/docs/IrDeviceDetails.md deleted file mode 100644 index ca2d67f..0000000 --- a/docs/IrDeviceDetails.md +++ /dev/null @@ -1,15 +0,0 @@ -# SmartThingsNet.Model.IrDeviceDetails -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ParentDeviceId** | **string** | The id of the Parent device. | [optional] -**ProfileId** | **string** | The id of the profile that describes the device components and capabilities. | [optional] -**OcfDeviceType** | **string** | The OCF Device Type | [optional] -**IrCode** | **string** | The id of the ircode | [optional] -**FunctionCodes** | [**IrDeviceDetailsFunctionCodes**](IrDeviceDetailsFunctionCodes.md) | | [optional] -**ChildDevices** | [**List<IrDeviceDetails>**](IrDeviceDetails.md) | list of child devices | [optional] -**Metadata** | **Object** | Key value pairs stored in the conductor for the device. UI Metadata information | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/IrDeviceDetailsFunctionCodes.md b/docs/IrDeviceDetailsFunctionCodes.md deleted file mode 100644 index fbec4b0..0000000 --- a/docs/IrDeviceDetailsFunctionCodes.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.IrDeviceDetailsFunctionCodes -List of IR function codes -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Default** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/IsaResults.md b/docs/IsaResults.md deleted file mode 100644 index 56b21a2..0000000 --- a/docs/IsaResults.md +++ /dev/null @@ -1,15 +0,0 @@ -# SmartThingsNet.Model.IsaResults -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IsaId** | **string** | isaId installed for the user | [optional] -**AppName** | **string** | Viper connector name given by partner in DevWorkspace eg Lifx (Connect) | [optional] -**PartnerName** | **string** | Parnter name eg Lifx Inc | [optional] -**Icon** | **string** | url of partner icon | [optional] -**Icon2x** | **string** | url of partner icon in 2x dimensions | [optional] -**Icon3x** | **string** | url of partner icon in 3x dimensions | [optional] -**LocationId** | **string** | location of the installed smart app | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LambdaSmartApp.md b/docs/LambdaSmartApp.md deleted file mode 100644 index 54dcdd2..0000000 --- a/docs/LambdaSmartApp.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.LambdaSmartApp -Details related to a Lambda Smart App implementation. This model will only be available for apps of type LAMBDA_SMART_APP. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Functions** | **List<string>** | A list of AWS arns referencing a Lambda function. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LessThanCondition.md b/docs/LessThanCondition.md deleted file mode 100644 index 72f41fa..0000000 --- a/docs/LessThanCondition.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.LessThanCondition -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the condition | [optional] -**Left** | [**Operand**](Operand.md) | | -**Right** | [**Operand**](Operand.md) | | -**Aggregation** | [**ConditionAggregationMode**](ConditionAggregationMode.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LessThanOrEqualsCondition.md b/docs/LessThanOrEqualsCondition.md deleted file mode 100644 index 8abc7b2..0000000 --- a/docs/LessThanOrEqualsCondition.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.LessThanOrEqualsCondition -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the condition | [optional] -**Left** | [**Operand**](Operand.md) | | -**Right** | [**Operand**](Operand.md) | | -**Aggregation** | [**ConditionAggregationMode**](ConditionAggregationMode.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Link.md b/docs/Link.md deleted file mode 100644 index dbdac02..0000000 --- a/docs/Link.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.Link -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Href** | **string** | An absolute URL linking to a resource. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Links.md b/docs/Links.md deleted file mode 100644 index 2b8a9fa..0000000 --- a/docs/Links.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.Links -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Next** | [**Link**](Link.md) | | [optional] -**Previous** | [**Link**](Link.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LocaleReference.md b/docs/LocaleReference.md deleted file mode 100644 index bc73747..0000000 --- a/docs/LocaleReference.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.LocaleReference -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Tag** | **string** | The tag of the locale as defined in [RFC bcp47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt). | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LocaleVariables.md b/docs/LocaleVariables.md deleted file mode 100644 index 08533f7..0000000 --- a/docs/LocaleVariables.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.LocaleVariables -Message template variables associated with a certain locale. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LocaleTag** | **string** | The tag of the locale as defined in [RFC bcp47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt). | -**Variables** | **Dictionary<string, string>** | A map<string,string> with the key representing the variable name, and the value representing the verbiage to be replaced in template string. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Location.md b/docs/Location.md deleted file mode 100644 index 602e1dd..0000000 --- a/docs/Location.md +++ /dev/null @@ -1,19 +0,0 @@ -# SmartThingsNet.Model.Location -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LocationId** | **Guid** | The ID of the location. | [optional] -**Name** | **string** | A name given for the location (eg. Home) | [optional] -**CountryCode** | **string** | An ISO Alpha-3 country code. (i.e. GBR, USA) | [optional] -**Latitude** | **decimal** | A geographical latitude. | [optional] -**Longitude** | **decimal** | A geographical longitude. | [optional] -**RegionRadius** | **int** | The radius in meters around latitude and longitude which defines this location. | [optional] -**TemperatureScale** | **string** | The desired temperature scale used within location. Value can be F or C. | [optional] -**TimeZoneId** | **string** | An ID matching the Java Time Zone ID of the location. Automatically generated if latitude and longitude have been provided. | [optional] -**Locale** | **string** | An IETF BCP 47 language tag representing the chosen locale for this location. | [optional] -**BackgroundImage** | **string** | Not currently in use. | [optional] -**AdditionalProperties** | **Dictionary<string, string>** | Additional information about the location that allows SmartThings to further define your location. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LocationAction.md b/docs/LocationAction.md deleted file mode 100644 index bdf4f9d..0000000 --- a/docs/LocationAction.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.LocationAction -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the action | -**Mode** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LocationAttribute.md b/docs/LocationAttribute.md deleted file mode 100644 index 557679f..0000000 --- a/docs/LocationAttribute.md +++ /dev/null @@ -1,8 +0,0 @@ -# SmartThingsNet.Model.LocationAttribute -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LocationOperand.md b/docs/LocationOperand.md deleted file mode 100644 index cca4950..0000000 --- a/docs/LocationOperand.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.LocationOperand -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attribute** | **LocationAttribute** | | -**Value** | **string** | Optional value to allow UI to reference a location attribute by id. If value is provided, the operand resolves to this value rather than calling the backend API | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LocationsApi.md b/docs/LocationsApi.md deleted file mode 100644 index ab1eb80..0000000 --- a/docs/LocationsApi.md +++ /dev/null @@ -1,414 +0,0 @@ -# SmartThingsNet.Api.LocationsApi - -All URIs are relative to *https://api.smartthings.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateLocation**](LocationsApi.md#createlocation) | **POST** /locations | Create a Location. -[**DeleteLocation**](LocationsApi.md#deletelocation) | **DELETE** /locations/{locationId} | Delete a Location. -[**GetLocation**](LocationsApi.md#getlocation) | **GET** /locations/{locationId} | Get a Location. -[**ListLocations**](LocationsApi.md#listlocations) | **GET** /locations | List Locations. -[**UpdateLocation**](LocationsApi.md#updatelocation) | **PUT** /locations/{locationId} | Update a Location. - - - -# **CreateLocation** -> Location CreateLocation (CreateLocationRequest createLocationRequest) - -Create a Location. - -Create a Location for a user. We will try and create the Location geographically close to the country code provided in the request body. If we do not support Location creation in the requested country code, then the API will return a 422 error response with an error code of UnsupportedGeoRegionError. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class CreateLocationExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new LocationsApi(config); - - var createLocationRequest = new CreateLocationRequest(); // CreateLocationRequest | - - try - { - // Create a Location. - Location result = apiInstance.CreateLocation(createLocationRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling LocationsApi.CreateLocation: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **createLocationRequest** | [**CreateLocationRequest**](CreateLocationRequest.md)| | - -### Return type - -[**Location**](Location.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Created successfully. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **DeleteLocation** -> Object DeleteLocation (string locationId) - -Delete a Location. - -Delete a Location from a user's account. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class DeleteLocationExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new LocationsApi(config); - - var locationId = locationId_example; // string | The ID of the location. - - try - { - // Delete a Location. - Object result = apiInstance.DeleteLocation(locationId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling LocationsApi.DeleteLocation: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The ID of the location. | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An empty object response. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetLocation** -> Location GetLocation (string locationId) - -Get a Location. - -Get a specific Location from a user's account. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetLocationExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new LocationsApi(config); - - var locationId = locationId_example; // string | The ID of the location. - - try - { - // Get a Location. - Location result = apiInstance.GetLocation(locationId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling LocationsApi.GetLocation: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The ID of the location. | - -### Return type - -[**Location**](Location.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | A Location. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **ListLocations** -> PagedLocations ListLocations (string authorization) - -List Locations. - -List all Locations currently available in a user account. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ListLocationsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new LocationsApi(config); - - - try - { - // List Locations. - PagedLocations result = apiInstance.ListLocations(authorization); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling LocationsApi.ListLocations: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - -### Return type - -[**PagedLocations**](PagedLocations.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An array of Locations | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **UpdateLocation** -> Location UpdateLocation (string locationId, UpdateLocationRequest updateLocationRequest) - -Update a Location. - -All the fields in the request body are optional. Only the specified fields will be updated. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class UpdateLocationExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new LocationsApi(config); - - var locationId = locationId_example; // string | The ID of the location. - var updateLocationRequest = new UpdateLocationRequest(); // UpdateLocationRequest | - - try - { - // Update a Location. - Location result = apiInstance.UpdateLocation(locationId, updateLocationRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling LocationsApi.UpdateLocation: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The ID of the location. | - **updateLocationRequest** | [**UpdateLocationRequest**](UpdateLocationRequest.md)| | - -### Return type - -[**Location**](Location.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | A Location. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Message.md b/docs/Message.md deleted file mode 100644 index b2d25fd..0000000 --- a/docs/Message.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.Message -A Message contains a list of message templates representing the same message in different locales. The system will serve the template with the locale that best matches the Recipient's language preferences. If the user's language preferences do not correlate to any message templates, the template defined by the `fallbackLocale` will be used. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**FallbackLocale** | **string** | The tag of the locale as defined in [RFC bcp47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt). | -**Templates** | [**List<MessageTemplate>**](MessageTemplate.md) | A list of templates representing the same message in different languages. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/MessageConfig.md b/docs/MessageConfig.md deleted file mode 100644 index 6e34935..0000000 --- a/docs/MessageConfig.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.MessageConfig -A message configuration. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MessageGroupKey** | **string** | The key value of the message group. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/MessageTemplate.md b/docs/MessageTemplate.md deleted file mode 100644 index 29f0a82..0000000 --- a/docs/MessageTemplate.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.MessageTemplate -A message template definition, representing a message in a specific locale. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LocaleTag** | **string** | The tag of the locale as defined in [RFC bcp47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt). | -**Template** | **string** | A message template string. Specify variables using the double curly braces convention. i.e. \"Hello, {{ firstName }}!\" | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/MessageType.md b/docs/MessageType.md deleted file mode 100644 index 472be88..0000000 --- a/docs/MessageType.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.MessageType -The expected message format to be sent. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Mode.md b/docs/Mode.md deleted file mode 100644 index 70d2045..0000000 --- a/docs/Mode.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.Mode -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Globally unique id for the mode. | -**Label** | **string** | A name provided by the User. Unique per location, updatable. | -**Name** | **string** | A name provided when the mode was created. The name is unique per location, and can not be updated. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ModeConfig.md b/docs/ModeConfig.md deleted file mode 100644 index b0cce73..0000000 --- a/docs/ModeConfig.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.ModeConfig -A mode configuration. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ModeId** | **string** | The ID of the mode. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ModeEvent.md b/docs/ModeEvent.md deleted file mode 100644 index 6e9e31a..0000000 --- a/docs/ModeEvent.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.ModeEvent -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EventId** | **string** | The id of the event. | [optional] -**LocationId** | **string** | The id of the location in which the event was triggered. | [optional] -**ModeId** | **string** | The ID of the mode associated with a MODE_EVENT. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ModeSubscriptionDetail.md b/docs/ModeSubscriptionDetail.md deleted file mode 100644 index e1ea436..0000000 --- a/docs/ModeSubscriptionDetail.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.ModeSubscriptionDetail -Details of a subscription of source type MODE. This will subscribe to all mode changes for the given location. The installed app can then act on the resulting mode change event accordingly. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LocationId** | **string** | The GUID for the location to subscribe to mode changes. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Notice.md b/docs/Notice.md deleted file mode 100644 index d3c5c2a..0000000 --- a/docs/Notice.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.Notice -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Code** | **NoticeCode** | | [optional] -**BadgeUrl** | **string** | The url of the badge icon for the notice card | [optional] -**Message** | **string** | The localized message to be displayed | [optional] -**Actions** | [**List<NoticeAction>**](NoticeAction.md) | The action(s) a user can take to resolve this notice | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/NoticeAction.md b/docs/NoticeAction.md deleted file mode 100644 index 146a9d5..0000000 --- a/docs/NoticeAction.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.NoticeAction -An action the user can take to resolve a notice -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/NoticeCode.md b/docs/NoticeCode.md deleted file mode 100644 index 55f3156..0000000 --- a/docs/NoticeCode.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.NoticeCode -* USER_PAUSE - Denotes installed app is paused by the user and user action is required to unpause it. * REVISIT - Denotes installed app is still running and user action may be required to reconcile a configuration. * RECONFIGURE - Denotes installed app is no longer running and user action is required to resolve a configuration issue. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OnceSchedule.md b/docs/OnceSchedule.md deleted file mode 100644 index 35acd1f..0000000 --- a/docs/OnceSchedule.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.OnceSchedule -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Time** | **long** | The time in millis from jan 1 1970 UTC for ONCE schedules. Must be less than 2 years from now. | -**Overwrite** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Operand.md b/docs/Operand.md deleted file mode 100644 index 9f380b9..0000000 --- a/docs/Operand.md +++ /dev/null @@ -1,19 +0,0 @@ -# SmartThingsNet.Model.Operand -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Boolean** | **bool** | | [optional] -**Decimal** | **double** | | [optional] -**Integer** | **long** | | [optional] -**String** | **string** | | [optional] -**Array** | [**ArrayOperand**](ArrayOperand.md) | | [optional] -**Map** | [**Dictionary<string, Operand>**](Operand.md) | | [optional] -**Device** | [**DeviceOperand**](DeviceOperand.md) | | [optional] -**Location** | [**LocationOperand**](LocationOperand.md) | | [optional] -**Date** | [**DateOperand**](DateOperand.md) | | [optional] -**Time** | [**TimeOperand**](TimeOperand.md) | | [optional] -**Datetime** | [**DateTimeOperand**](DateTimeOperand.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OperandAggregationMode.md b/docs/OperandAggregationMode.md deleted file mode 100644 index a08cf3b..0000000 --- a/docs/OperandAggregationMode.md +++ /dev/null @@ -1,8 +0,0 @@ -# SmartThingsNet.Model.OperandAggregationMode -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Owner.md b/docs/Owner.md deleted file mode 100644 index 9d91e5e..0000000 --- a/docs/Owner.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.Owner -A typed model which provides information around ownership of a specific domain. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**OwnerType** | **string** | The account type which owns the specific domain item. | [optional] [default to OwnerTypeEnum.USER] -**OwnerId** | **string** | A global idenfifier for owner. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedApp.md b/docs/PagedApp.md deleted file mode 100644 index 9f1f524..0000000 --- a/docs/PagedApp.md +++ /dev/null @@ -1,18 +0,0 @@ -# SmartThingsNet.Model.PagedApp -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AppName** | **string** | A user defined unique identifier for an app. It is alpha-numeric, may contain dashes, underscores, periods, and be less then 250 characters long. It must be unique within your account. | [optional] -**AppId** | **Guid** | A globally unique identifier for an app. | [optional] -**AppType** | **AppType** | | [optional] -**Classifications** | [**List<AppClassification>**](AppClassification.md) | An App maybe associated to many classifications. A classification drives how the integration is presented to the user in the SmartThings mobile clients. These classifications include: * AUTOMATION - Denotes an integration that should display under the \"Automation\" tab in mobile clients. * SERVICE - Denotes an integration that is classified as a \"Service\". * DEVICE - Denotes an integration that should display under the \"Device\" tab in mobile clients. * CONNECTED_SERVICE - Denotes an integration that should display under the \"Connected Services\" menu in mobile clients. * HIDDEN - Denotes an integration that should not display in mobile clients | [optional] -**DisplayName** | **string** | A default display name for an app. | [optional] -**Description** | **string** | A default description for an app. | [optional] -**IconImage** | [**IconImage**](IconImage.md) | | [optional] -**Owner** | [**Owner**](Owner.md) | | [optional] -**CreatedDate** | **DateTime** | A UTC ISO-8601 Date-Time String | [optional] -**LastUpdatedDate** | **DateTime** | A UTC ISO-8601 Date-Time String | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedApps.md b/docs/PagedApps.md deleted file mode 100644 index b4dd4d1..0000000 --- a/docs/PagedApps.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.PagedApps -Represents a single page of Apps available in an account. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | [**List<PagedApp>**](PagedApp.md) | | [optional] -**Links** | [**Links**](Links.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedDeviceProfiles.md b/docs/PagedDeviceProfiles.md deleted file mode 100644 index 2741fe3..0000000 --- a/docs/PagedDeviceProfiles.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.PagedDeviceProfiles -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | [**List<DeviceProfile>**](DeviceProfile.md) | | [optional] -**Links** | [**Links**](Links.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedDevices.md b/docs/PagedDevices.md deleted file mode 100644 index e1eeb0f..0000000 --- a/docs/PagedDevices.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.PagedDevices -A paginated array of devices. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | [**List<Device>**](Device.md) | | [optional] -**Links** | [**Links**](Links.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedInstallConfigurations.md b/docs/PagedInstallConfigurations.md deleted file mode 100644 index 04830da..0000000 --- a/docs/PagedInstallConfigurations.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.PagedInstallConfigurations -Represents a single page of InstallConfiguration models available for an InstalledApp. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | [**List<InstallConfiguration>**](InstallConfiguration.md) | | [optional] -**Links** | [**Links**](Links.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedInstalledApps.md b/docs/PagedInstalledApps.md deleted file mode 100644 index c6558e3..0000000 --- a/docs/PagedInstalledApps.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.PagedInstalledApps -Represents a single page of InstalledApps available in a user account. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | [**List<InstalledApp>**](InstalledApp.md) | | [optional] -**Links** | [**Links**](Links.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedLocation.md b/docs/PagedLocation.md deleted file mode 100644 index 023fb41..0000000 --- a/docs/PagedLocation.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.PagedLocation -A slimmed down represenation of the Location model. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LocationId** | **Guid** | The ID of the location. | [optional] -**Name** | **string** | A name given for the location (eg. Home) | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedLocations.md b/docs/PagedLocations.md deleted file mode 100644 index b645012..0000000 --- a/docs/PagedLocations.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.PagedLocations -Represents a single page of Locations available in a user account. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | [**List<PagedLocation>**](PagedLocation.md) | | [optional] -**Links** | [**Links**](Links.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedMessageTemplate.md b/docs/PagedMessageTemplate.md deleted file mode 100644 index 3154a2a..0000000 --- a/docs/PagedMessageTemplate.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.PagedMessageTemplate -A simplified Message model which is retured during a list operation. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AppId** | **Guid** | A globally unique identifier for an app. | -**MessageTemplateKey** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedRooms.md b/docs/PagedRooms.md deleted file mode 100644 index 7740faa..0000000 --- a/docs/PagedRooms.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.PagedRooms -Represents a single page of Rooms available in a Location. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | [**List<Room>**](Room.md) | | [optional] -**Links** | [**Links**](Links.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedRules.md b/docs/PagedRules.md deleted file mode 100644 index 9cfa7b8..0000000 --- a/docs/PagedRules.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.PagedRules -An array of rules -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | [**List<Rule>**](Rule.md) | | [optional] -**Links** | [**Links**](Links.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedSchedules.md b/docs/PagedSchedules.md deleted file mode 100644 index 4488e39..0000000 --- a/docs/PagedSchedules.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.PagedSchedules -An array of schedules -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | [**List<Schedule>**](Schedule.md) | | [optional] -**Links** | [**Links**](Links.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PagedSubscriptions.md b/docs/PagedSubscriptions.md deleted file mode 100644 index d89af19..0000000 --- a/docs/PagedSubscriptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.PagedSubscriptions -An array of subscriptions -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | [**List<Subscription>**](Subscription.md) | | [optional] -**Links** | [**Links**](Links.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ParentType.md b/docs/ParentType.md deleted file mode 100644 index d176b05..0000000 --- a/docs/ParentType.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.ParentType -The source of the rule -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PermissionConfig.md b/docs/PermissionConfig.md deleted file mode 100644 index 8c4a8fc..0000000 --- a/docs/PermissionConfig.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.PermissionConfig -Required permissions for the installed app. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Permissions** | **List<string>** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PredefinedMessage.md b/docs/PredefinedMessage.md deleted file mode 100644 index 85185e9..0000000 --- a/docs/PredefinedMessage.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.PredefinedMessage -Predefined message options. Variables from `localeVariables` matching the locale of the Message will be assigned first, then `defaultVariables`. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MessageTemplateKey** | **string** | | -**DefaultVariables** | **Dictionary<string, string>** | A map<string,string> with the key representing the variable name, and the value representing the verbiage to be replaced in template string. `defaultVariables` are only used when there are no matching `localeVariables`. | [optional] -**LocaleVariables** | [**List<LocaleVariables>**](LocaleVariables.md) | Variables to resolve for specific locales. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PrincipalType.md b/docs/PrincipalType.md deleted file mode 100644 index 4f301c4..0000000 --- a/docs/PrincipalType.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.PrincipalType -Denotes the principal type to be used with the app. Default is LOCATION. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Room.md b/docs/Room.md deleted file mode 100644 index 9b967f2..0000000 --- a/docs/Room.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.Room -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RoomId** | **Guid** | The ID of the room. | [optional] -**LocationId** | **Guid** | The ID of the parent location. | [optional] -**Name** | **string** | A name given for the room (eg. Living Room) | [optional] -**BackgroundImage** | **string** | Not currently in use. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RoomsApi.md b/docs/RoomsApi.md deleted file mode 100644 index ba04387..0000000 --- a/docs/RoomsApi.md +++ /dev/null @@ -1,424 +0,0 @@ -# SmartThingsNet.Api.RoomsApi - -All URIs are relative to *https://api.smartthings.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateRoom**](RoomsApi.md#createroom) | **POST** /locations/{locationId}/rooms | Create a Room. -[**DeleteRoom**](RoomsApi.md#deleteroom) | **DELETE** /locations/{locationId}/rooms/{roomId} | Delete a Room. -[**GetRoom**](RoomsApi.md#getroom) | **GET** /locations/{locationId}/rooms/{roomId} | Get a Room. -[**ListRooms**](RoomsApi.md#listrooms) | **GET** /locations/{locationId}/rooms | List Rooms. -[**UpdateRoom**](RoomsApi.md#updateroom) | **PUT** /locations/{locationId}/rooms/{roomId} | Update a Room. - - - -# **CreateRoom** -> Room CreateRoom (string locationId, CreateRoomRequest createRoomRequest) - -Create a Room. - -Create a Room for the Location. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class CreateRoomExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new RoomsApi(config); - - var locationId = locationId_example; // string | The ID of the location. - var createRoomRequest = new CreateRoomRequest(); // CreateRoomRequest | - - try - { - // Create a Room. - Room result = apiInstance.CreateRoom(locationId, createRoomRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RoomsApi.CreateRoom: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The ID of the location. | - **createRoomRequest** | [**CreateRoomRequest**](CreateRoomRequest.md)| | - -### Return type - -[**Room**](Room.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Created successfully. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **DeleteRoom** -> Object DeleteRoom (string locationId, string roomId) - -Delete a Room. - -Delete a Room from a location. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class DeleteRoomExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new RoomsApi(config); - - var locationId = locationId_example; // string | The ID of the location. - var roomId = roomId_example; // string | The ID of the room. - - try - { - // Delete a Room. - Object result = apiInstance.DeleteRoom(locationId, roomId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RoomsApi.DeleteRoom: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The ID of the location. | - **roomId** | **string**| The ID of the room. | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An empty object response. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetRoom** -> Room GetRoom (string locationId, string roomId) - -Get a Room. - -Get a specific Room. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetRoomExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new RoomsApi(config); - - var locationId = locationId_example; // string | The ID of the location. - var roomId = roomId_example; // string | The ID of the room. - - try - { - // Get a Room. - Room result = apiInstance.GetRoom(locationId, roomId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RoomsApi.GetRoom: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The ID of the location. | - **roomId** | **string**| The ID of the room. | - -### Return type - -[**Room**](Room.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | A Room. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **ListRooms** -> PagedRooms ListRooms (string locationId) - -List Rooms. - -List all Rooms currently available in a Location. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ListRoomsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new RoomsApi(config); - - var locationId = locationId_example; // string | The ID of the location. - - try - { - // List Rooms. - PagedRooms result = apiInstance.ListRooms(locationId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RoomsApi.ListRooms: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The ID of the location. | - -### Return type - -[**PagedRooms**](PagedRooms.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An array of Rooms | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **UpdateRoom** -> Room UpdateRoom (string locationId, string roomId, UpdateRoomRequest updateRoomRequest) - -Update a Room. - -All the fields in the request body are optional. Only the specified fields will be updated. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class UpdateRoomExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new RoomsApi(config); - - var locationId = locationId_example; // string | The ID of the location. - var roomId = roomId_example; // string | The ID of the room. - var updateRoomRequest = new UpdateRoomRequest(); // UpdateRoomRequest | - - try - { - // Update a Room. - Room result = apiInstance.UpdateRoom(locationId, roomId, updateRoomRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RoomsApi.UpdateRoom: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The ID of the location. | - **roomId** | **string**| The ID of the room. | - **updateRoomRequest** | [**UpdateRoomRequest**](UpdateRoomRequest.md)| | - -### Return type - -[**Room**](Room.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | A Room. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Rule.md b/docs/Rule.md deleted file mode 100644 index 5bf9889..0000000 --- a/docs/Rule.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.Rule -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | Name for the rule | -**Actions** | [**List<Action>**](Action.md) | | -**TimeZoneId** | **string** | Time zone ID for this rule. This overrides the location time zone ID, but is overridden by time zone ID provided by each operand individually | [optional] -**Id** | **string** | Unique id for the rule | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RuleAllOf.md b/docs/RuleAllOf.md deleted file mode 100644 index b29ea33..0000000 --- a/docs/RuleAllOf.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.RuleAllOf -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the rule | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RuleExecutionResponse.md b/docs/RuleExecutionResponse.md deleted file mode 100644 index 2c820fe..0000000 --- a/docs/RuleExecutionResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.RuleExecutionResponse -The result of a rule execution -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RuleId** | **string** | | -**Result** | **ExecutionResult** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RuleMetadata.md b/docs/RuleMetadata.md deleted file mode 100644 index 14622ab..0000000 --- a/docs/RuleMetadata.md +++ /dev/null @@ -1,19 +0,0 @@ -# SmartThingsNet.Model.RuleMetadata -Defines a rule with its associated meta data. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **string** | | [optional] -**Rule** | [**Rule**](Rule.md) | | -**InstalledAppId** | **string** | The ID of the installed application. | -**LocationId** | **string** | The ID of the location. | -**ParentId** | **string** | The source ID that created the rule | [optional] -**ParentType** | **ParentType** | | [optional] -**UserUuid** | **string** | The uuid of the user | [optional] -**ExecutingLocally** | **bool** | Boolean for whether rule is installed locally | [optional] -**DateCreated** | **string** | The date when rule was created | [optional] -**DateUpdated** | **string** | The date when rule was last updated | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RuleRequest.md b/docs/RuleRequest.md deleted file mode 100644 index 03bcd3a..0000000 --- a/docs/RuleRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.RuleRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | Name for the rule | -**Actions** | [**List<Action>**](Action.md) | | -**TimeZoneId** | **string** | Time zone ID for this rule. This overrides the location time zone ID, but is overridden by time zone ID provided by each operand individually | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RulesApi.md b/docs/RulesApi.md deleted file mode 100644 index 46b53d2..0000000 --- a/docs/RulesApi.md +++ /dev/null @@ -1,499 +0,0 @@ -# SmartThingsNet.Api.RulesApi - -All URIs are relative to *https://api.smartthings.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateRule**](RulesApi.md#createrule) | **POST** /rules | Create a rule -[**DeleteRule**](RulesApi.md#deleterule) | **DELETE** /rules/{ruleId} | Delete a rule -[**ExecuteRule**](RulesApi.md#executerule) | **POST** /rules/execute/{ruleId} | Execute a rule -[**GetRule**](RulesApi.md#getrule) | **GET** /rules/{ruleId} | Get a Rule -[**ListRules**](RulesApi.md#listrules) | **GET** /rules | Rules list -[**UpdateRule**](RulesApi.md#updaterule) | **PUT** /rules/{ruleId} | Update a rule - - - -# **CreateRule** -> Object CreateRule (string locationId, RuleRequest request) - -Create a rule - -Create a rule for the location and token principal - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class CreateRuleExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new RulesApi(config); - - var locationId = locationId_example; // string | The ID of the location in which to create the rule in. - var request = new RuleRequest(); // RuleRequest | The rule to be created. - - try - { - // Create a rule - Object result = apiInstance.CreateRule(locationId, request); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RulesApi.CreateRule: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The ID of the location in which to create the rule in. | - **request** | [**RuleRequest**](RuleRequest.md)| The rule to be created. | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The created rule | - | -| **401** | Not authenticated | - | -| **403** | Not authorized | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **DeleteRule** -> Rule DeleteRule (string ruleId, string locationId) - -Delete a rule - -Delete a rule - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class DeleteRuleExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new RulesApi(config); - - var ruleId = ruleId_example; // string | The rule ID - var locationId = locationId_example; // string | The ID of the location in which to delete the rule in. - - try - { - // Delete a rule - Rule result = apiInstance.DeleteRule(ruleId, locationId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RulesApi.DeleteRule: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **ruleId** | **string**| The rule ID | - **locationId** | **string**| The ID of the location in which to delete the rule in. | - -### Return type - -[**Rule**](Rule.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successfully deleted | - | -| **401** | Not authenticated | - | -| **403** | Not authorized or not found | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **ExecuteRule** -> RuleExecutionResponse ExecuteRule (string ruleId, string locationId) - -Execute a rule - -Trigger Rule execution given a rule ID - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ExecuteRuleExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new RulesApi(config); - - var ruleId = ruleId_example; // string | The rule ID - var locationId = locationId_example; // string | The ID of the location that both the installed smart app and source are associated with. - - try - { - // Execute a rule - RuleExecutionResponse result = apiInstance.ExecuteRule(ruleId, locationId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RulesApi.ExecuteRule: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **ruleId** | **string**| The rule ID | - **locationId** | **string**| The ID of the location that both the installed smart app and source are associated with. | - -### Return type - -[**RuleExecutionResponse**](RuleExecutionResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successfully Executed | - | -| **401** | Not authenticated | - | -| **403** | Not authorized or not found | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetRule** -> Rule GetRule (string ruleId, string locationId) - -Get a Rule - -Get a rule - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetRuleExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new RulesApi(config); - - var ruleId = ruleId_example; // string | The rule ID - var locationId = locationId_example; // string | The ID of the location to list the rules for. - - try - { - // Get a Rule - Rule result = apiInstance.GetRule(ruleId, locationId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RulesApi.GetRule: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **ruleId** | **string**| The rule ID | - **locationId** | **string**| The ID of the location to list the rules for. | - -### Return type - -[**Rule**](Rule.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The rule | - | -| **401** | Not authenticated | - | -| **403** | Not authorized or not found | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **ListRules** -> PagedRules ListRules (string locationId, int? max = null, int? offset = null) - -Rules list - -List of rules for the location for the given token principal - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ListRulesExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new RulesApi(config); - - var locationId = locationId_example; // string | The ID of the location to list the rules for. - var max = 56; // int? | The max number of rules to fetch (optional) - var offset = 56; // int? | The start index of rules to fetch (optional) - - try - { - // Rules list - PagedRules result = apiInstance.ListRules(locationId, max, offset); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RulesApi.ListRules: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The ID of the location to list the rules for. | - **max** | **int?**| The max number of rules to fetch | [optional] - **offset** | **int?**| The start index of rules to fetch | [optional] - -### Return type - -[**PagedRules**](PagedRules.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | A paginated list of rules. | - | -| **400** | Bad request | - | -| **401** | Not authenticated | - | -| **403** | Not authorized or not found | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **UpdateRule** -> Rule UpdateRule (string ruleId, string locationId, RuleRequest request) - -Update a rule - -Update a rule - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class UpdateRuleExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new RulesApi(config); - - var ruleId = ruleId_example; // string | The rule ID - var locationId = locationId_example; // string | The ID of the location in which to update the rule in. - var request = new RuleRequest(); // RuleRequest | The rule to be updated. - - try - { - // Update a rule - Rule result = apiInstance.UpdateRule(ruleId, locationId, request); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RulesApi.UpdateRule: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **ruleId** | **string**| The rule ID | - **locationId** | **string**| The ID of the location in which to update the rule in. | - **request** | [**RuleRequest**](RuleRequest.md)| The rule to be updated. | - -### Return type - -[**Rule**](Rule.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The rule | - | -| **401** | Not authenticated | - | -| **403** | Not authorized or not found | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SceneAction.md b/docs/SceneAction.md deleted file mode 100644 index 957b3d2..0000000 --- a/docs/SceneAction.md +++ /dev/null @@ -1,13 +0,0 @@ -# SmartThingsNet.Model.SceneAction -Possible scene actions, mutually exclusive -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceRequest** | [**SceneDeviceRequest**](SceneDeviceRequest.md) | | [optional] -**ModeRequest** | [**SceneModeRequest**](SceneModeRequest.md) | | [optional] -**SleepRequest** | [**SceneSleepRequest**](SceneSleepRequest.md) | | [optional] -**DeviceGroupRequest** | [**SceneDeviceGroupRequest**](SceneDeviceGroupRequest.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneArgument.md b/docs/SceneArgument.md deleted file mode 100644 index 70ca74d..0000000 --- a/docs/SceneArgument.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.SceneArgument -A capability command argument -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | the name of the command | [optional] -**Schema** | **Object** | the schema of the command | [optional] -**Value** | **Object** | The value being set for the capability command | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneCapability.md b/docs/SceneCapability.md deleted file mode 100644 index 333408f..0000000 --- a/docs/SceneCapability.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.SceneCapability -A device component capability -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CapabilityId** | **string** | The id of the capability | [optional] -**Status** | **string** | The status of the capability | [optional] -**Commands** | [**Dictionary<string, SceneCommand>**](SceneCommand.md) | Capability commands | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneCommand.md b/docs/SceneCommand.md deleted file mode 100644 index 9c4f5d4..0000000 --- a/docs/SceneCommand.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.SceneCommand -A component capability command -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Arguments** | [**List<SceneArgument>**](SceneArgument.md) | the command arguments | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneComponent.md b/docs/SceneComponent.md deleted file mode 100644 index b2a339e..0000000 --- a/docs/SceneComponent.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.SceneComponent -A component of the scene device -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ComponentId** | **string** | the id of the component | [optional] -**Capabilities** | [**List<SceneCapability>**](SceneCapability.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneConfig.md b/docs/SceneConfig.md deleted file mode 100644 index 2cd5ecf..0000000 --- a/docs/SceneConfig.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.SceneConfig -A scene configuration. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SceneId** | **string** | The ID of the scene. | [optional] -**Permissions** | **List<string>** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneDevice.md b/docs/SceneDevice.md deleted file mode 100644 index 14f0e69..0000000 --- a/docs/SceneDevice.md +++ /dev/null @@ -1,14 +0,0 @@ -# SmartThingsNet.Model.SceneDevice -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceId** | **string** | the id of the device | [optional] -**DeviceLabel** | **string** | the label of the device | [optional] -**DeviceName** | **string** | the name of the device | [optional] -**DeviceTypeId** | **string** | The identifier for the device's DeviceType. | [optional] -**Components** | [**List<SceneComponent>**](SceneComponent.md) | | [optional] -**LocationId** | **string** | Location of the device | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneDeviceGroup.md b/docs/SceneDeviceGroup.md deleted file mode 100644 index 9ee88fb..0000000 --- a/docs/SceneDeviceGroup.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.SceneDeviceGroup -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceGroupId** | **string** | the id of the device | [optional] -**Capability** | [**SceneCapability**](SceneCapability.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneDeviceGroupRequest.md b/docs/SceneDeviceGroupRequest.md deleted file mode 100644 index d73fa2b..0000000 --- a/docs/SceneDeviceGroupRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.SceneDeviceGroupRequest -JSON structure for a device group when creating a Scene -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceGroupId** | **string** | the id of the device group | -**ActionId** | **string** | the id of the action to be created. Optional, sent by Reaver only | [optional] -**Capability** | [**SceneCapability**](SceneCapability.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneDeviceRequest.md b/docs/SceneDeviceRequest.md deleted file mode 100644 index edd3ed1..0000000 --- a/docs/SceneDeviceRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.SceneDeviceRequest -JSON structure for a device when creating a Scene -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DeviceId** | **string** | the id of the device | [optional] -**ActionId** | **string** | the id of the action to be created. Optional, sent by Reaver only | [optional] -**Components** | [**List<SceneComponent>**](SceneComponent.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneLifecycle.md b/docs/SceneLifecycle.md deleted file mode 100644 index f00daf7..0000000 --- a/docs/SceneLifecycle.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.SceneLifecycle -The scene lifecycle. The lifecycle will be one of: * CREATE - Invoked when a scene is created. * UPDATE - Invoked when a scene is updated. * DELETE - Invoked when a scene is deleted. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneLifecycleDetail.md b/docs/SceneLifecycleDetail.md deleted file mode 100644 index d35f132..0000000 --- a/docs/SceneLifecycleDetail.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.SceneLifecycleDetail -Details of a subscription of source type SCENE_LIFECYCLE. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SubscriptionName** | **string** | A name for the subscription that will be passed to the installed app. | [optional] -**LocationId** | **string** | The id of the location that both the app and scenes are in. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneLifecycleEvent.md b/docs/SceneLifecycleEvent.md deleted file mode 100644 index 1725e74..0000000 --- a/docs/SceneLifecycleEvent.md +++ /dev/null @@ -1,16 +0,0 @@ -# SmartThingsNet.Model.SceneLifecycleEvent -A scene lifecycle event. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Lifecycle** | **SceneLifecycle** | | [optional] -**EventId** | **string** | The id of the event. | [optional] -**LocationId** | **string** | The id of the location in which the event was triggered. | [optional] -**SceneId** | **string** | The id of the scene. | [optional] -**Create** | **Object** | Create scene lifecycle. | [optional] -**Update** | **Object** | Update scene lifecycle. | [optional] -**Delete** | **Object** | Delete scene lifecycle. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneMode.md b/docs/SceneMode.md deleted file mode 100644 index 7e003a9..0000000 --- a/docs/SceneMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.SceneMode -The mode activated by the Scene -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ModeId** | **string** | the id of the mode | [optional] -**ModeName** | **string** | the name of the mode | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneModeRequest.md b/docs/SceneModeRequest.md deleted file mode 100644 index ae0e0d5..0000000 --- a/docs/SceneModeRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.SceneModeRequest -The mode to be activated by the Scene -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ModeId** | **string** | The id of the mode | -**ActionId** | **string** | the id of the action to be created. Optional, sent by Reaver only | [optional] -**ModeName** | **string** | The name of the mode | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ScenePagedResult.md b/docs/ScenePagedResult.md deleted file mode 100644 index 0a07a2b..0000000 --- a/docs/ScenePagedResult.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.ScenePagedResult -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | [**List<SceneSummary>**](SceneSummary.md) | | [optional] -**Links** | [**Links**](Links.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneRequest.md b/docs/SceneRequest.md deleted file mode 100644 index 2c56fd7..0000000 --- a/docs/SceneRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# SmartThingsNet.Model.SceneRequest -JSON body for creating or updating a Scene -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SceneName** | **string** | The user-defined name of the Scene | -**SceneIcon** | **string** | The name of the icon | [optional] -**SceneColor** | **string** | The color of the icon | [optional] -**Devices** | [**List<SceneDeviceRequest>**](SceneDeviceRequest.md) | Non-sequential list of device actions | -**Sequences** | **List<List>** | List of parallel action sequences | [optional] -**Mode** | [**SceneModeRequest**](SceneModeRequest.md) | | [optional] -**SecurityMode** | [**SceneSecurityModeRequest**](SceneSecurityModeRequest.md) | | [optional] -**Devicegroups** | [**List<SceneDeviceGroupRequest>**](SceneDeviceGroupRequest.md) | List of device group actions | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneSecurityModeRequest.md b/docs/SceneSecurityModeRequest.md deleted file mode 100644 index 22bb27e..0000000 --- a/docs/SceneSecurityModeRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.SceneSecurityModeRequest -The security mode to be activated by the Scene -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ActionId** | **string** | the id of the action to be created. Optional, sent by Reaver only | [optional] -**Security** | **string** | The id of the security mode | -**Arguments** | **string** | Additional query param | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneSleepRequest.md b/docs/SceneSleepRequest.md deleted file mode 100644 index 9744e0c..0000000 --- a/docs/SceneSleepRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.SceneSleepRequest -Sleep a particular sequence -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Seconds** | **int** | Number of seconds to sleep the sequence | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SceneSummary.md b/docs/SceneSummary.md deleted file mode 100644 index 291b193..0000000 --- a/docs/SceneSummary.md +++ /dev/null @@ -1,19 +0,0 @@ -# SmartThingsNet.Model.SceneSummary -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SceneId** | **string** | The unique identifier of the Scene | [optional] -**SceneName** | **string** | The user-defined name of the Scene | [optional] -**SceneIcon** | **string** | The name of the icon | [optional] -**SceneColor** | **string** | The color of the icon | [optional] -**LocationId** | **string** | Location of the Scene | [optional] -**CreatedBy** | **string** | The unique identifier of the user that created the scene | [optional] -**CreatedDate** | **DateTime** | The date the scene was created | [optional] -**LastUpdatedDate** | **DateTime** | The date the scene was last updated | [optional] -**LastExecutedDate** | **DateTime** | The date the scene was last executed | [optional] -**Editable** | **bool** | Whether or not this scene can be edited by the logged in user using the version of the app that made the request | [optional] -**ApiVersion** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ScenesApi.md b/docs/ScenesApi.md deleted file mode 100644 index 4ba48eb..0000000 --- a/docs/ScenesApi.md +++ /dev/null @@ -1,170 +0,0 @@ -# SmartThingsNet.Api.ScenesApi - -All URIs are relative to *https://api.smartthings.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**ExecuteScene**](ScenesApi.md#executescene) | **POST** /scenes/{sceneId}/execute | Execute Scene -[**ListScenes**](ScenesApi.md#listscenes) | **GET** /scenes | List Scenes - - - -# **ExecuteScene** -> StandardSuccessResponse ExecuteScene (string sceneId, string locationId = null) - -Execute Scene - -Execute a Scene by id for the logged in user and given locationId - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ExecuteSceneExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new ScenesApi(config); - - var sceneId = sceneId_example; // string | The ID of the Scene. - var locationId = locationId_example; // string | The location of a scene. (optional) - - try - { - // Execute Scene - StandardSuccessResponse result = apiInstance.ExecuteScene(sceneId, locationId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling ScenesApi.ExecuteScene: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **sceneId** | **string**| The ID of the Scene. | - **locationId** | **string**| The location of a scene. | [optional] - -### Return type - -[**StandardSuccessResponse**](StandardSuccessResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Scene has been executed | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **ListScenes** -> ScenePagedResult ListScenes (string locationId = null) - -List Scenes - -Fetch a list of Scenes for the logged in user filtered by locationIds. If no locationId is sent, return scenes for all available locations - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ListScenesExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new ScenesApi(config); - - var locationId = locationId_example; // string | The location of a scene. (optional) - - try - { - // List Scenes - ScenePagedResult result = apiInstance.ListScenes(locationId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling ScenesApi.ListScenes: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorization** | **string**| OAuth token | - **locationId** | **string**| The location of a scene. | [optional] - -### Return type - -[**ScenePagedResult**](ScenePagedResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.smartthings+json, application/json, - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Scenes have been fetched | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Schedule.md b/docs/Schedule.md deleted file mode 100644 index 3a9b147..0000000 --- a/docs/Schedule.md +++ /dev/null @@ -1,13 +0,0 @@ -# SmartThingsNet.Model.Schedule -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**InstalledAppId** | **Guid** | The ID of the installed app. | [optional] -**LocationId** | **Guid** | The ID of the location the installed app is in. | [optional] -**ScheduledExecutions** | **List<long>** | list of scheduled execution times in millis from jan 1 1970 UTC | [optional] -**Name** | **string** | The unique per installed app name of the schedule. | -**Cron** | [**CronSchedule**](CronSchedule.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ScheduleRequest.md b/docs/ScheduleRequest.md deleted file mode 100644 index b366177..0000000 --- a/docs/ScheduleRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.ScheduleRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Once** | [**OnceSchedule**](OnceSchedule.md) | | [optional] -**Name** | **string** | The unique per installed app name of the schedule. | -**Cron** | [**CronSchedule**](CronSchedule.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SchedulesApi.md b/docs/SchedulesApi.md deleted file mode 100644 index 02ef7dd..0000000 --- a/docs/SchedulesApi.md +++ /dev/null @@ -1,420 +0,0 @@ -# SmartThingsNet.Api.SchedulesApi - -All URIs are relative to *https://api.smartthings.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateSchedule**](SchedulesApi.md#createschedule) | **POST** /installedapps/{installedAppId}/schedules | Save an installed app schedule. -[**DeleteSchedule**](SchedulesApi.md#deleteschedule) | **DELETE** /installedapps/{installedAppId}/schedules/{scheduleName} | Delete a schedule. -[**DeleteSchedules**](SchedulesApi.md#deleteschedules) | **DELETE** /installedapps/{installedAppId}/schedules | Delete all of an installed app's schedules. -[**GetSchedule**](SchedulesApi.md#getschedule) | **GET** /installedapps/{installedAppId}/schedules/{scheduleName} | Get an installed app's schedule. -[**GetSchedules**](SchedulesApi.md#getschedules) | **GET** /installedapps/{installedAppId}/schedules | List installed app schedules. - - - -# **CreateSchedule** -> Schedule CreateSchedule (string installedAppId, string authorization, ScheduleRequest request = null) - -Save an installed app schedule. - -Create a schedule for an installed app. The installed app must be in the location specified and the installed app must have permission to create schedules. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class CreateScheduleExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new SchedulesApi(config); - var installedAppId = installedAppId_example; // string | The ID of the installed application. - - var request = new ScheduleRequest(); // ScheduleRequest | The schedule to be created. (optional) - - try - { - // Save an installed app schedule. - Schedule result = apiInstance.CreateSchedule(installedAppId, authorization, request); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SchedulesApi.CreateSchedule: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **installedAppId** | **string**| The ID of the installed application. | - **authorization** | **string**| OAuth token | - **request** | [**ScheduleRequest**](ScheduleRequest.md)| The schedule to be created. | [optional] - -### Return type - -[**Schedule**](Schedule.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The created schedule. | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **DeleteSchedule** -> Object DeleteSchedule (string installedAppId, string scheduleName, string authorization) - -Delete a schedule. - -Delete a specific schedule for the installed app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class DeleteScheduleExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new SchedulesApi(config); - var installedAppId = installedAppId_example; // string | The ID of the installed application. - var scheduleName = scheduleName_example; // string | The name of the schedule - - - try - { - // Delete a schedule. - Object result = apiInstance.DeleteSchedule(installedAppId, scheduleName, authorization); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SchedulesApi.DeleteSchedule: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **installedAppId** | **string**| The ID of the installed application. | - **scheduleName** | **string**| The name of the schedule | - **authorization** | **string**| OAuth token | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successfully deleted | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **DeleteSchedules** -> Object DeleteSchedules (string installedAppId, string authorization) - -Delete all of an installed app's schedules. - -Delete all schedules for the installed app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class DeleteSchedulesExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new SchedulesApi(config); - var installedAppId = installedAppId_example; // string | The ID of the installed application. - - - try - { - // Delete all of an installed app's schedules. - Object result = apiInstance.DeleteSchedules(installedAppId, authorization); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SchedulesApi.DeleteSchedules: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **installedAppId** | **string**| The ID of the installed application. | - **authorization** | **string**| OAuth token | - -### Return type - -**Object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successfully deleted | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetSchedule** -> Schedule GetSchedule (string installedAppId, string scheduleName, string authorization) - -Get an installed app's schedule. - -Get a specific schedule for the installed app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetScheduleExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new SchedulesApi(config); - var installedAppId = installedAppId_example; // string | The ID of the installed application. - var scheduleName = scheduleName_example; // string | The name of the schedule - - - try - { - // Get an installed app's schedule. - Schedule result = apiInstance.GetSchedule(installedAppId, scheduleName, authorization); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SchedulesApi.GetSchedule: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **installedAppId** | **string**| The ID of the installed application. | - **scheduleName** | **string**| The name of the schedule | - **authorization** | **string**| OAuth token | - -### Return type - -[**Schedule**](Schedule.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The schedule | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetSchedules** -> PagedSchedules GetSchedules (string installedAppId, string authorization) - -List installed app schedules. - -List the schedules for the installed app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetSchedulesExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new SchedulesApi(config); - var installedAppId = installedAppId_example; // string | The ID of the installed application. - - - try - { - // List installed app schedules. - PagedSchedules result = apiInstance.GetSchedules(installedAppId, authorization); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SchedulesApi.GetSchedules: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **installedAppId** | **string**| The ID of the installed application. | - **authorization** | **string**| OAuth token | - -### Return type - -[**PagedSchedules**](PagedSchedules.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | A paged schedules list | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SecurityArmStateDetail.md b/docs/SecurityArmStateDetail.md deleted file mode 100644 index 38c3ca0..0000000 --- a/docs/SecurityArmStateDetail.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.SecurityArmStateDetail -Details of a subscription of souce type SECURITY_ARM_STATE -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SubscriptionName** | **string** | A name for the subscription that will be passed to the installed app. | [optional] -**LocationId** | **string** | The id of the location that both the app and the security system are in. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SecurityArmStateEvent.md b/docs/SecurityArmStateEvent.md deleted file mode 100644 index fdcf36a..0000000 --- a/docs/SecurityArmStateEvent.md +++ /dev/null @@ -1,13 +0,0 @@ -# SmartThingsNet.Model.SecurityArmStateEvent -An event that represents a change in the arm state of a security system. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EventId** | **string** | The id of the event. | [optional] -**LocationId** | **string** | The id of the location in which the event was triggered. | [optional] -**ArmState** | **string** | The arm state of a security system. | [optional] -**OptionalArguments** | [**Dictionary<string, SimpleValue>**](SimpleValue.md) | A set of key / value pairs useful for passing any optional arguments. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SignatureType.md b/docs/SignatureType.md deleted file mode 100644 index d91fecd..0000000 --- a/docs/SignatureType.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.SignatureType -The http signature type used for authorizing event delivery. APP_RSA generates an RSA key pair that will be used to verify requests from SmartThings. ST_PADLOCK requires verifcation through SmartThings public certificate. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SimpleCondition.md b/docs/SimpleCondition.md deleted file mode 100644 index 3a42874..0000000 --- a/docs/SimpleCondition.md +++ /dev/null @@ -1,12 +0,0 @@ -# SmartThingsNet.Model.SimpleCondition -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the condition | [optional] -**Left** | [**Operand**](Operand.md) | | -**Right** | [**Operand**](Operand.md) | | -**Aggregation** | **ConditionAggregationMode** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SimpleValue.md b/docs/SimpleValue.md deleted file mode 100644 index 14847dd..0000000 --- a/docs/SimpleValue.md +++ /dev/null @@ -1,14 +0,0 @@ -# SmartThingsNet.Model.SimpleValue -A simple value. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ValueType** | **string** | The type of the value. | [optional] -**IntValue** | **int** | | [optional] -**DoubleValue** | **double** | | [optional] -**StringValue** | **string** | | [optional] -**BoolValue** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SingleOperandCondition.md b/docs/SingleOperandCondition.md deleted file mode 100644 index a87a44a..0000000 --- a/docs/SingleOperandCondition.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.SingleOperandCondition -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the condition | [optional] -**Left** | [**Operand**](Operand.md) | | -**Aggregation** | **ConditionAggregationMode** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SleepAction.md b/docs/SleepAction.md deleted file mode 100644 index 93d1057..0000000 --- a/docs/SleepAction.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.SleepAction -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id for the action | [optional] -**Duration** | [**Interval**](Interval.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SmartAppDashboardCardEventRequest.md b/docs/SmartAppDashboardCardEventRequest.md deleted file mode 100644 index 03c15da..0000000 --- a/docs/SmartAppDashboardCardEventRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.SmartAppDashboardCardEventRequest -An event used to trigger a client action on a SmartApp dashboard card. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CardId** | **string** | A developer defined dashboard card ID. | [optional] -**Lifecycle** | **DashboardCardLifecycle** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SmartAppEventRequest.md b/docs/SmartAppEventRequest.md deleted file mode 100644 index f7f137b..0000000 --- a/docs/SmartAppEventRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.SmartAppEventRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | An arbitrary name for the custom SmartApp event. Typically useful as a hook for in-app routing. | [optional] -**Attributes** | **Dictionary<string, string>** | An arbitrary set of key / value pairs useful for passing any custom metadata. * Supports a maximum of 10 entries. * Maximum key length: 36 Unicode characters in UTF-8 * Maximum value length: 256 Unicode characters in UTF-8 * Allowed characters for *keys* are letters, plus the following special characters: `:`, `_` * Allowed characters for *values* are letters, whitespace, and numbers, plus the following special characters: `+`, `-`, `=`, `.`, `_`, `:`, `/` * If you need characters outside this allowed set, you can apply standard base-64 encoding. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/StandardSuccessResponse.md b/docs/StandardSuccessResponse.md deleted file mode 100644 index b588f4e..0000000 --- a/docs/StandardSuccessResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.StandardSuccessResponse -{\"status\": \"success\"} -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | **string** | | [optional] [default to StatusEnum.Success] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/StringConfig.md b/docs/StringConfig.md deleted file mode 100644 index bc2b879..0000000 --- a/docs/StringConfig.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.StringConfig -A simple string configuration. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | **string** | A config value | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Subscription.md b/docs/Subscription.md deleted file mode 100644 index 7ba9330..0000000 --- a/docs/Subscription.md +++ /dev/null @@ -1,19 +0,0 @@ -# SmartThingsNet.Model.Subscription -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | The id of the subscription. | [optional] -**InstalledAppId** | **string** | The id of the subscribing app. | [optional] -**SourceType** | **SubscriptionSource** | | [optional] -**Device** | [**DeviceSubscriptionDetail**](DeviceSubscriptionDetail.md) | | [optional] -**Capability** | [**CapabilitySubscriptionDetail**](CapabilitySubscriptionDetail.md) | | [optional] -**Mode** | [**ModeSubscriptionDetail**](ModeSubscriptionDetail.md) | | [optional] -**DeviceLifecycle** | [**DeviceLifecycleDetail**](DeviceLifecycleDetail.md) | | [optional] -**DeviceHealth** | [**DeviceHealthDetail**](DeviceHealthDetail.md) | | [optional] -**SecurityArmState** | [**SecurityArmStateDetail**](SecurityArmStateDetail.md) | | [optional] -**HubHealth** | [**HubHealthDetail**](HubHealthDetail.md) | | [optional] -**SceneLifecycle** | [**SceneLifecycleDetail**](SceneLifecycleDetail.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SubscriptionDelete.md b/docs/SubscriptionDelete.md deleted file mode 100644 index d84f637..0000000 --- a/docs/SubscriptionDelete.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.SubscriptionDelete -The number of deleted subscriptions -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Count** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SubscriptionFilter.md b/docs/SubscriptionFilter.md deleted file mode 100644 index 8fa548a..0000000 --- a/docs/SubscriptionFilter.md +++ /dev/null @@ -1,14 +0,0 @@ -# SmartThingsNet.Model.SubscriptionFilter -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **SubscriptionFilterTypes** | | [optional] -**Value** | **List<string>** | An array of subscription filter values. | [optional] -**EventType** | **List<string>** | | [optional] -**Attribute** | **List<string>** | | [optional] -**Capability** | **List<string>** | | [optional] -**Component** | **List<string>** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SubscriptionFilterTypes.md b/docs/SubscriptionFilterTypes.md deleted file mode 100644 index 2c01636..0000000 --- a/docs/SubscriptionFilterTypes.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.SubscriptionFilterTypes -The type of filter -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SubscriptionMode.md b/docs/SubscriptionMode.md deleted file mode 100644 index 5847027..0000000 --- a/docs/SubscriptionMode.md +++ /dev/null @@ -1,8 +0,0 @@ -# SmartThingsNet.Model.SubscriptionMode -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SubscriptionRequest.md b/docs/SubscriptionRequest.md deleted file mode 100644 index 44d2124..0000000 --- a/docs/SubscriptionRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# SmartThingsNet.Model.SubscriptionRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceType** | **SubscriptionSource** | | -**Device** | [**DeviceSubscriptionDetail**](DeviceSubscriptionDetail.md) | | [optional] -**Capability** | [**CapabilitySubscriptionDetail**](CapabilitySubscriptionDetail.md) | | [optional] -**Mode** | [**ModeSubscriptionDetail**](ModeSubscriptionDetail.md) | | [optional] -**DeviceLifecycle** | [**DeviceLifecycleDetail**](DeviceLifecycleDetail.md) | | [optional] -**DeviceHealth** | [**DeviceHealthDetail**](DeviceHealthDetail.md) | | [optional] -**SecurityArmState** | [**SecurityArmStateDetail**](SecurityArmStateDetail.md) | | [optional] -**HubHealth** | [**HubHealthDetail**](HubHealthDetail.md) | | [optional] -**SceneLifecycle** | [**SceneLifecycleDetail**](SceneLifecycleDetail.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SubscriptionSource.md b/docs/SubscriptionSource.md deleted file mode 100644 index 280f278..0000000 --- a/docs/SubscriptionSource.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.SubscriptionSource -The type of the event that is being subscribed to. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SubscriptionTarget.md b/docs/SubscriptionTarget.md deleted file mode 100644 index cf7acfb..0000000 --- a/docs/SubscriptionTarget.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.SubscriptionTarget -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Url** | **string** | The address to send events to. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SubscriptionsApi.md b/docs/SubscriptionsApi.md deleted file mode 100644 index 5129d11..0000000 --- a/docs/SubscriptionsApi.md +++ /dev/null @@ -1,413 +0,0 @@ -# SmartThingsNet.Api.SubscriptionsApi - -All URIs are relative to *https://api.smartthings.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**DeleteAllSubscriptions**](SubscriptionsApi.md#deleteallsubscriptions) | **DELETE** /installedapps/{installedAppId}/subscriptions | Delete all of an installed app's subscriptions. -[**DeleteSubscription**](SubscriptionsApi.md#deletesubscription) | **DELETE** /installedapps/{installedAppId}/subscriptions/{subscriptionId} | Delete an installed app's subscription. -[**GetSubscription**](SubscriptionsApi.md#getsubscription) | **GET** /installedapps/{installedAppId}/subscriptions/{subscriptionId} | Get an installed app's subscription. -[**ListSubscriptions**](SubscriptionsApi.md#listsubscriptions) | **GET** /installedapps/{installedAppId}/subscriptions | List an installed app's subscriptions. -[**SaveSubscription**](SubscriptionsApi.md#savesubscription) | **POST** /installedapps/{installedAppId}/subscriptions | Create a subscription for an installed app. - - - -# **DeleteAllSubscriptions** -> SubscriptionDelete DeleteAllSubscriptions (string installedAppId, string authorization, string deviceId = null, string modeId = null) - -Delete all of an installed app's subscriptions. - -Delete all subscriptions for the installed app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class DeleteAllSubscriptionsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - var apiInstance = new SubscriptionsApi(config); - var installedAppId = installedAppId_example; // string | The ID of the installed application. - - var deviceId = deviceId_example; // string | Limit deletion to subscriptions for a particular device. (optional) - var modeId = modeId_example; // string | Limit deletion to subscriptions for a particular mode or deletes parent if last mode (optional) - - try - { - // Delete all of an installed app's subscriptions. - SubscriptionDelete result = apiInstance.DeleteAllSubscriptions(installedAppId, authorization, deviceId, modeId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SubscriptionsApi.DeleteAllSubscriptions: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **installedAppId** | **string**| The ID of the installed application. | - **authorization** | **string**| OAuth token | - **deviceId** | **string**| Limit deletion to subscriptions for a particular device. | [optional] - **modeId** | **string**| Limit deletion to subscriptions for a particular mode or deletes parent if last mode | [optional] - -### Return type - -[**SubscriptionDelete**](SubscriptionDelete.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successfully deleted | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **DeleteSubscription** -> SubscriptionDelete DeleteSubscription (string installedAppId, string subscriptionId, string authorization) - -Delete an installed app's subscription. - -Delete a specific subscription for the installed app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class DeleteSubscriptionExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - var apiInstance = new SubscriptionsApi(config); - var installedAppId = installedAppId_example; // string | The ID of the installed application. - var subscriptionId = subscriptionId_example; // string | The ID of the subscription - - - try - { - // Delete an installed app's subscription. - SubscriptionDelete result = apiInstance.DeleteSubscription(installedAppId, subscriptionId, authorization); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SubscriptionsApi.DeleteSubscription: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **installedAppId** | **string**| The ID of the installed application. | - **subscriptionId** | **string**| The ID of the subscription | - **authorization** | **string**| OAuth token | - -### Return type - -[**SubscriptionDelete**](SubscriptionDelete.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successfully deleted | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetSubscription** -> Subscription GetSubscription (string installedAppId, string subscriptionId, string authorization) - -Get an installed app's subscription. - -Get a specific subscription for the installed app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class GetSubscriptionExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - var apiInstance = new SubscriptionsApi(config); - var installedAppId = installedAppId_example; // string | The ID of the installed application. - var subscriptionId = subscriptionId_example; // string | The ID of the subscription - - - try - { - // Get an installed app's subscription. - Subscription result = apiInstance.GetSubscription(installedAppId, subscriptionId, authorization); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SubscriptionsApi.GetSubscription: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **installedAppId** | **string**| The ID of the installed application. | - **subscriptionId** | **string**| The ID of the subscription | - **authorization** | **string**| OAuth token | - -### Return type - -[**Subscription**](Subscription.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The subscription | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **ListSubscriptions** -> PagedSubscriptions ListSubscriptions (string installedAppId, string authorization) - -List an installed app's subscriptions. - -List the subscriptions for the installed app. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class ListSubscriptionsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - var apiInstance = new SubscriptionsApi(config); - var installedAppId = installedAppId_example; // string | The ID of the installed application. - - - try - { - // List an installed app's subscriptions. - PagedSubscriptions result = apiInstance.ListSubscriptions(installedAppId, authorization); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SubscriptionsApi.ListSubscriptions: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **installedAppId** | **string**| The ID of the installed application. | - **authorization** | **string**| OAuth token | - -### Return type - -[**PagedSubscriptions**](PagedSubscriptions.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | An array of subscriptions | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **SaveSubscription** -> Subscription SaveSubscription (string installedAppId, string authorization, SubscriptionRequest request = null) - -Create a subscription for an installed app. - -Create a subscription to a type of event from the specified source. Both the source and the installed app must be in the location specified and the installed app must have read access to the event being subscribed to. An installed app is only permitted to created 20 subscriptions. ### Authorization scopes For installed app principal: * installed app id matches the incoming request installed app id location must match the installed app location | Subscription Type | Scope required | | - -- -- -- -- -- -- -- -- - | - -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --| | DEVICE | `r:devices:$deviceId` | | CAPABILITY | `r:devices:*:*:$capability` or `r:devices:*`, | | MODE | `r:locations:$locationId` or `r:locations:*` | | DEVICE_LIFECYCLE | `r:devices:$deviceId` or `r:devices:*` | | DEVICE_HEALTH | `r:devices:$deviceId` or `r:devices:*` | | SECURITY_ARM_STATE | `r:security:locations:$locationId:armstate` or `r:security:locations:*:armstate` | | HUB_HEALTH | `r:hubs` | | SCENE_LIFECYCLE | `r:scenes:*` | - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using SmartThingsNet.Api; -using SmartThingsNet.Client; -using SmartThingsNet.Model; - -namespace Example -{ - public class SaveSubscriptionExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "https://api.smartthings.com/v1"; - // Configure OAuth2 access token for authorization: Bearer - config.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new SubscriptionsApi(config); - var installedAppId = installedAppId_example; // string | The ID of the installed application. - - var request = new SubscriptionRequest(); // SubscriptionRequest | The Subscription to be created. (optional) - - try - { - // Create a subscription for an installed app. - Subscription result = apiInstance.SaveSubscription(installedAppId, authorization, request); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SubscriptionsApi.SaveSubscription: " + e.Message ); - Debug.Print("Status Code: "+ e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **installedAppId** | **string**| The ID of the installed application. | - **authorization** | **string**| OAuth token | - **request** | [**SubscriptionRequest**](SubscriptionRequest.md)| The Subscription to be created. | [optional] - -### Return type - -[**Subscription**](Subscription.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The subscription | - | -| **400** | Bad request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **409** | Conflict | - | -| **422** | Unprocessable Entity | - | -| **429** | Too many requests | - | -| **0** | Unexpected error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TimeOperand.md b/docs/TimeOperand.md deleted file mode 100644 index 06f1d1e..0000000 --- a/docs/TimeOperand.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.TimeOperand -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TimeZoneId** | **string** | A java time zone ID reference | [optional] -**Reference** | **TimeReference** | | -**Offset** | [**Interval**](Interval.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TimeReference.md b/docs/TimeReference.md deleted file mode 100644 index 07328cd..0000000 --- a/docs/TimeReference.md +++ /dev/null @@ -1,8 +0,0 @@ -# SmartThingsNet.Model.TimeReference -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TimerEvent.md b/docs/TimerEvent.md deleted file mode 100644 index 033b9b0..0000000 --- a/docs/TimerEvent.md +++ /dev/null @@ -1,14 +0,0 @@ -# SmartThingsNet.Model.TimerEvent -An event that is caused by a schedule for this app being fired. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EventId** | **string** | The ID of the event. | [optional] -**Name** | **string** | The name of the schedule that caused this event. | [optional] -**Type** | **TimerType** | | [optional] -**Time** | **DateTime** | The IS0-8601 date time strings in UTC that this event was scheduled for. | [optional] -**Expression** | **string** | The CRON expression if the schedule was of type CRON. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TimerType.md b/docs/TimerType.md deleted file mode 100644 index 1358f55..0000000 --- a/docs/TimerType.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.TimerType -The type of TIMER_EVENT. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateAppOAuthRequest.md b/docs/UpdateAppOAuthRequest.md deleted file mode 100644 index dea02f4..0000000 --- a/docs/UpdateAppOAuthRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# SmartThingsNet.Model.UpdateAppOAuthRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ClientName** | **string** | A name given to the OAuth Client. | -**Scope** | **List<string>** | A list of SmartThings API OAuth scope identifiers that maybe required to execute your integration. | -**RedirectUris** | **List<string>** | A list of redirect URIs. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateAppRequest.md b/docs/UpdateAppRequest.md deleted file mode 100644 index 0f53955..0000000 --- a/docs/UpdateAppRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# SmartThingsNet.Model.UpdateAppRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DisplayName** | **string** | A default display name for an app. | -**Description** | **string** | A default description for an app. | -**SingleInstance** | **bool** | Inform the installation systems that a particular app can only be installed once within a user's account. | [optional] [default to false] -**IconImage** | [**IconImage**](IconImage.md) | | [optional] -**AppType** | **AppType** | | -**Classifications** | [**List<AppClassification>**](AppClassification.md) | An App maybe associated to many classifications. A classification drives how the integration is presented to the user in the SmartThings mobile clients. These classifications include: * AUTOMATION - Denotes an integration that should display under the \"Automation\" tab in mobile clients. * SERVICE - Denotes an integration that is classified as a \"Service\". * DEVICE - Denotes an integration that should display under the \"Device\" tab in mobile clients. * CONNECTED_SERVICE - Denotes an integration that should display under the \"Connected Services\" menu in mobile clients. * HIDDEN - Denotes an integration that should not display in mobile clients | -**LambdaSmartApp** | [**CreateOrUpdateLambdaSmartAppRequest**](CreateOrUpdateLambdaSmartAppRequest.md) | | [optional] -**WebhookSmartApp** | [**CreateOrUpdateWebhookSmartAppRequest**](CreateOrUpdateWebhookSmartAppRequest.md) | | [optional] -**Ui** | [**AppUISettings**](AppUISettings.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateAppSettingsRequest.md b/docs/UpdateAppSettingsRequest.md deleted file mode 100644 index 6fd6a14..0000000 --- a/docs/UpdateAppSettingsRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.UpdateAppSettingsRequest -Settings for a given app -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Settings** | **Dictionary<string, string>** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateAppSettingsResponse.md b/docs/UpdateAppSettingsResponse.md deleted file mode 100644 index 8ba38b1..0000000 --- a/docs/UpdateAppSettingsResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.UpdateAppSettingsResponse -Settings for a given app -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Settings** | **Dictionary<string, string>** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateDeviceProfileRequest.md b/docs/UpdateDeviceProfileRequest.md deleted file mode 100644 index 6e6d002..0000000 --- a/docs/UpdateDeviceProfileRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.UpdateDeviceProfileRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Components** | [**List<DeviceComponentReference>**](DeviceComponentReference.md) | A list of `[ 1..20 ]` components for this profile. | [optional] -**Metadata** | **Dictionary<string, string>** | Additional information about the device profile, limited to 10 entries. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateDeviceRequest.md b/docs/UpdateDeviceRequest.md deleted file mode 100644 index b8a9edd..0000000 --- a/docs/UpdateDeviceRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.UpdateDeviceRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Label** | **string** | The label for the device. | -**Components** | [**List<UpdateDeviceRequestComponents>**](UpdateDeviceRequestComponents.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateDeviceRequestComponents.md b/docs/UpdateDeviceRequestComponents.md deleted file mode 100644 index 45be6a8..0000000 --- a/docs/UpdateDeviceRequestComponents.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.UpdateDeviceRequestComponents -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | | -**Categories** | **List<string>** | A case-sensitive string from the pre-defined list of valid categories [/devicecategories](#/operation/listCategories). | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateLocationRequest.md b/docs/UpdateLocationRequest.md deleted file mode 100644 index 662f96e..0000000 --- a/docs/UpdateLocationRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# SmartThingsNet.Model.UpdateLocationRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | A nickname for the location. | -**Latitude** | **decimal** | A geographical latitude. | [optional] -**Longitude** | **decimal** | A geographical longitude. | [optional] -**RegionRadius** | **int** | The radius in meters around latitude and longitude which defines this location. | [optional] -**TemperatureScale** | **string** | The desired temperature scale used within location. Value can be F or C. | [optional] -**Locale** | **string** | An IETF BCP 47 language tag representing the chosen locale for this location. | [optional] -**AdditionalProperties** | **Dictionary<string, string>** | Additional information about the location that allows SmartThings to further define your location. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateRoomRequest.md b/docs/UpdateRoomRequest.md deleted file mode 100644 index cf3ec9c..0000000 --- a/docs/UpdateRoomRequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# SmartThingsNet.Model.UpdateRoomRequest -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **string** | A name for the room. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateSignatureTypeRequest.md b/docs/UpdateSignatureTypeRequest.md deleted file mode 100644 index 6d75090..0000000 --- a/docs/UpdateSignatureTypeRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# SmartThingsNet.Model.UpdateSignatureTypeRequest -A request object used to switch the signing mechanism for authorizing SmartApp callbacks. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SignatureType** | **SignatureType** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ViperDeviceDetails.md b/docs/ViperDeviceDetails.md deleted file mode 100644 index 052f74b..0000000 --- a/docs/ViperDeviceDetails.md +++ /dev/null @@ -1,13 +0,0 @@ -# SmartThingsNet.Model.ViperDeviceDetails -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UniqueIdentifier** | **string** | | [optional] -**ManufacturerName** | **string** | | [optional] -**ModelName** | **string** | | [optional] -**SwVersion** | **string** | | [optional] -**HwVersion** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/WebhookSmartApp.md b/docs/WebhookSmartApp.md deleted file mode 100644 index 2abe6cd..0000000 --- a/docs/WebhookSmartApp.md +++ /dev/null @@ -1,13 +0,0 @@ -# SmartThingsNet.Model.WebhookSmartApp -Details related to a Webhook Smart App implementation. This model will only be available for apps of type WEBHOOK_SMART_APP. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TargetUrl** | **string** | A URL that should be invoked during execution. | [optional] -**TargetStatus** | **AppTargetStatus** | | [optional] -**PublicKey** | **string** | The public half of an RSA key pair. Useful for verifying a Webhook execution request signature to ensure it came from SmartThings. | [optional] -**SignatureType** | **SignatureType** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) -