Documentation
¶
Index ¶
- Constants
- type Action
- type ActionType
- type AppLifecycle
- type BasicBackgroundImage
- type BasicBody
- type BasicButton
- type BasicButtonPosition
- type BasicButtonType
- type BasicCard
- type BasicIconButton
- type BasicImage
- type BasicImagePosition
- type BasicText
- type BasicTextButton
- type BooleanSetting
- type ClientDetails
- type ConfigEntries
- type ConfigEntry
- type ConfigMap
- type ConfigurationData
- type ConfigurationPhase
- type ConfigurationResponseData
- type DashboardCard
- type DashboardCardTemplate
- type DashboardData
- type DashboardResponseData
- type DecimalSetting
- type DeviceCommandsEvent
- type DeviceCommandsEventCommand
- type DeviceConfig
- type DeviceEvent
- type DeviceHealthEvent
- type DeviceLifecycle
- type DeviceLifecycleCreate
- type DeviceLifecycleDelete
- type DeviceLifecycleEvent
- type DeviceLifecycleMove
- type DeviceLifecycleUpdate
- type DeviceSetting
- type EmailSetting
- type EnumSetting
- type EnumStyleType
- type Event
- type EventData
- type EventResponseData
- type EventType
- type ExecuteAction
- type ExecutionRequest
- type ExecutionResponse
- type FreeFormCard
- type GroupedOption
- type ImageSetting
- type ImagesSetting
- type InitializeSetting
- func (m *InitializeSetting) MarshalBinary() ([]byte, error)
- func (m InitializeSetting) MarshalJSON() ([]byte, error)
- func (m *InitializeSetting) UnmarshalBinary(b []byte) error
- func (m *InitializeSetting) UnmarshalJSON(raw []byte) error
- func (m *InitializeSetting) Validate(formats strfmt.Registry) error
- type InstallData
- type InstallResponseData
- type InstalledApp
- type LaunchPluginAction
- type LinkSetting
- type LinkStyleType
- type ModeConfig
- type ModeEvent
- type ModeSetting
- type NumberSetting
- type OAuthCallbackData
- type OAuthCallbackResponseData
- type OAuthSetting
- type Option
- type Page
- type PageSetting
- type ParagraphSetting
- type PasswordSetting
- type Permissions
- type PhoneSetting
- type PingData
- type PingResponseData
- type SceneConfig
- type SceneLifecycle
- type SceneLifecycleCreate
- type SceneLifecycleDelete
- type SceneLifecycleEvent
- type SceneLifecycleUpdate
- type SceneSetting
- type Section
- type SectionSetting
- type SecurityArmStateEvent
- type Setting
- type SettingType
- type SimpleValue
- type StringConfig
- type StyleType
- type TextSetting
- type TimeSetting
- type TimerEvent
- type TimerType
- type UninstallData
- type UninstallResponseData
- type UpdateData
- type UpdateResponseData
- type VideoSetting
Constants ¶
const ( // ConfigEntryValueTypeSTRING captures enum value "STRING" ConfigEntryValueTypeSTRING string = "STRING" // ConfigEntryValueTypeDEVICE captures enum value "DEVICE" ConfigEntryValueTypeDEVICE string = "DEVICE" // ConfigEntryValueTypeMODE captures enum value "MODE" ConfigEntryValueTypeMODE string = "MODE" )
const ( // DeviceHealthEventReasonNONE captures enum value "NONE" DeviceHealthEventReasonNONE string = "NONE" // DeviceHealthEventReasonSERVICEUNAVAILABLE captures enum value "SERVICE_UNAVAILABLE" DeviceHealthEventReasonSERVICEUNAVAILABLE string = "SERVICE_UNAVAILABLE" // DeviceHealthEventReasonHUBOFFLINE captures enum value "HUB_OFFLINE" DeviceHealthEventReasonHUBOFFLINE string = "HUB_OFFLINE" // DeviceHealthEventReasonZWAVEOFFLINE captures enum value "ZWAVE_OFFLINE" DeviceHealthEventReasonZWAVEOFFLINE string = "ZWAVE_OFFLINE" // DeviceHealthEventReasonZIGBEEOFFLINE captures enum value "ZIGBEE_OFFLINE" DeviceHealthEventReasonZIGBEEOFFLINE string = "ZIGBEE_OFFLINE" // DeviceHealthEventReasonBLUETOOTHOFFLINE captures enum value "BLUETOOTH_OFFLINE" DeviceHealthEventReasonBLUETOOTHOFFLINE string = "BLUETOOTH_OFFLINE" // DeviceHealthEventReasonHUBDISCONNECTED captures enum value "HUB_DISCONNECTED" DeviceHealthEventReasonHUBDISCONNECTED string = "HUB_DISCONNECTED" )
const ( // DeviceHealthEventStatusOFFLINE captures enum value "OFFLINE" DeviceHealthEventStatusOFFLINE string = "OFFLINE" // DeviceHealthEventStatusONLINE captures enum value "ONLINE" DeviceHealthEventStatusONLINE string = "ONLINE" // DeviceHealthEventStatusUNHEALTHY captures enum value "UNHEALTHY" DeviceHealthEventStatusUNHEALTHY string = "UNHEALTHY" )
const ( // SecurityArmStateEventArmStateUNKNOWN captures enum value "UNKNOWN" SecurityArmStateEventArmStateUNKNOWN string = "UNKNOWN" // SecurityArmStateEventArmStateARMEDSTAY captures enum value "ARMED_STAY" SecurityArmStateEventArmStateARMEDSTAY string = "ARMED_STAY" // SecurityArmStateEventArmStateARMEDAWAY captures enum value "ARMED_AWAY" SecurityArmStateEventArmStateARMEDAWAY string = "ARMED_AWAY" // SecurityArmStateEventArmStateDISARMED captures enum value "DISARMED" SecurityArmStateEventArmStateDISARMED string = "DISARMED" )
const ( // SimpleValueValueTypeNULLVALUE captures enum value "NULL_VALUE" SimpleValueValueTypeNULLVALUE string = "NULL_VALUE" // SimpleValueValueTypeINTVALUE captures enum value "INT_VALUE" SimpleValueValueTypeINTVALUE string = "INT_VALUE" // SimpleValueValueTypeDOUBLEVALUE captures enum value "DOUBLE_VALUE" SimpleValueValueTypeDOUBLEVALUE string = "DOUBLE_VALUE" // SimpleValueValueTypeSTRINGVALUE captures enum value "STRING_VALUE" SimpleValueValueTypeSTRINGVALUE string = "STRING_VALUE" // SimpleValueValueTypeBOOLEANVALUE captures enum value "BOOLEAN_VALUE" SimpleValueValueTypeBOOLEANVALUE string = "BOOLEAN_VALUE" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Action ¶
type Action struct {
// execute
Execute *ExecuteAction `json:"execute,omitempty"`
// launch plugin
LaunchPlugin *LaunchPluginAction `json:"launchPlugin,omitempty"`
// type
Type ActionType `json:"type,omitempty"`
}
Action A definition of the action to be taken when button is activated. swagger:model Action
func (*Action) MarshalBinary ¶
MarshalBinary interface implementation
func (*Action) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ActionType ¶
type ActionType string
ActionType The type of action to take when UI element is activated.
* LAUNCH_PLUGIN - Launch a corresponding UI plugin. * EXECUTE - Execute an API call to the backing SmartApp.
swagger:model ActionType
const ( // ActionTypeLAUNCHPLUGIN captures enum value "LAUNCH_PLUGIN" ActionTypeLAUNCHPLUGIN ActionType = "LAUNCH_PLUGIN" // ActionTypeEXECUTE captures enum value "EXECUTE" ActionTypeEXECUTE ActionType = "EXECUTE" )
type AppLifecycle ¶
type AppLifecycle string
AppLifecycle Every invocation of a SmartApp is associated to a specific lifecycle event. These lifecycles include: * INSTALL - Lifecycle that will be invoked once at the time of installation of a SmartApp. * UPDATE - Invoked when a user modifies the configuration values assigned to the SmartApp. * UNINSTALL - A clean up lifecycle invoked upon the deletion of an SmartApp from a user's account. * EVENT - Lifecycle event used when the SmartApp is invoked as the result of a subscription or schedule. * PING - Lifecycle used during App creation to verify connectivity, and ownership of a particular target. * CONFIGURATION - Lifecycle used to drive the UX during the installation process of a SmartApp into a user's account. * OAUTH_CALLBACK - Lifecycle used for integrations that implement a third-party OAuth out.
swagger:model AppLifecycle
const ( // AppLifecycleINSTALL captures enum value "INSTALL" AppLifecycleINSTALL AppLifecycle = "INSTALL" // AppLifecycleUPDATE captures enum value "UPDATE" AppLifecycleUPDATE AppLifecycle = "UPDATE" // AppLifecycleUNINSTALL captures enum value "UNINSTALL" AppLifecycleUNINSTALL AppLifecycle = "UNINSTALL" // AppLifecycleEVENT captures enum value "EVENT" AppLifecycleEVENT AppLifecycle = "EVENT" // AppLifecyclePING captures enum value "PING" AppLifecyclePING AppLifecycle = "PING" // AppLifecycleCONFIGURATION captures enum value "CONFIGURATION" AppLifecycleCONFIGURATION AppLifecycle = "CONFIGURATION" // AppLifecycleOAUTHCALLBACK captures enum value "OAUTH_CALLBACK" AppLifecycleOAUTHCALLBACK AppLifecycle = "OAUTH_CALLBACK" )
type BasicBackgroundImage ¶
type BasicBackgroundImage struct {
// transparency of the color/image
Alpha float64 `json:"alpha,omitempty"`
// some color code
Color string `json:"color,omitempty"`
// URL of image. HTTPS url is required.
// Max Length: 250
// Format: uri
URL strfmt.URI `json:"url,omitempty"`
}
BasicBackgroundImage A background image. swagger:model BasicBackgroundImage
func (*BasicBackgroundImage) MarshalBinary ¶
func (m *BasicBackgroundImage) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BasicBackgroundImage) UnmarshalBinary ¶
func (m *BasicBackgroundImage) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BasicBody ¶
type BasicBody struct {
// image
Image *BasicImage `json:"image,omitempty"`
// text
Text *BasicText `json:"text,omitempty"`
}
BasicBody Body definition for a Basic V1 template. swagger:model BasicBody
func (*BasicBody) MarshalBinary ¶
MarshalBinary interface implementation
func (*BasicBody) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type BasicButton ¶
type BasicButton struct {
// icon button
IconButton *BasicIconButton `json:"iconButton,omitempty"`
// text button
TextButton *BasicTextButton `json:"textButton,omitempty"`
// type
Type BasicButtonType `json:"type,omitempty"`
}
BasicButton A button definition for a Basic V1 template. swagger:model BasicButton
func (*BasicButton) MarshalBinary ¶
func (m *BasicButton) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BasicButton) UnmarshalBinary ¶
func (m *BasicButton) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BasicButtonPosition ¶
type BasicButtonPosition string
BasicButtonPosition Position of where the button should be rendered within card. swagger:model BasicButtonPosition
const ( // BasicButtonPositionLEFT captures enum value "LEFT" BasicButtonPositionLEFT BasicButtonPosition = "LEFT" // BasicButtonPositionCENTER captures enum value "CENTER" BasicButtonPositionCENTER BasicButtonPosition = "CENTER" // BasicButtonPositionRIGHT captures enum value "RIGHT" BasicButtonPositionRIGHT BasicButtonPosition = "RIGHT" )
type BasicButtonType ¶
type BasicButtonType string
BasicButtonType The type of buttons to render.
* TEXT - A colored button with a text overrlay. * ICON - A button with an image backgroup and text overrlay.
swagger:model BasicButtonType
const ( // BasicButtonTypeTEXT captures enum value "TEXT" BasicButtonTypeTEXT BasicButtonType = "TEXT" // BasicButtonTypeICON captures enum value "ICON" BasicButtonTypeICON BasicButtonType = "ICON" )
type BasicCard ¶
type BasicCard struct {
// bg image
BgImage *BasicBackgroundImage `json:"bgImage,omitempty"`
// body
Body *BasicBody `json:"body,omitempty"`
// A list of buttons to render and buttons must be of the same type.
// Max Items: 3
Buttons []*BasicButton `json:"buttons"`
// An title icon url for card. A HTTPS URL is required.
// Max Length: 250
// Format: uri
IconURL strfmt.URI `json:"iconUrl,omitempty"`
// name of the card
// Max Length: 100
Name string `json:"name,omitempty"`
}
BasicCard Data requirements for a Basic V1 card template. swagger:model BasicCard
func (*BasicCard) MarshalBinary ¶
MarshalBinary interface implementation
func (*BasicCard) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type BasicIconButton ¶
type BasicIconButton struct {
// action
Action *Action `json:"action,omitempty"`
// A default icon image url. HTTPS url required.
// Max Length: 250
// Format: uri
IconURL strfmt.URI `json:"iconUrl,omitempty"`
// The name of the button
// Max Length: 100
Name string `json:"name,omitempty"`
// position
Position BasicButtonPosition `json:"position,omitempty"`
}
BasicIconButton A text button definition for a basic template. swagger:model BasicIconButton
func (*BasicIconButton) MarshalBinary ¶
func (m *BasicIconButton) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BasicIconButton) UnmarshalBinary ¶
func (m *BasicIconButton) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BasicImage ¶
type BasicImage struct {
// An icon name.
// Max Length: 100
Name string `json:"name,omitempty"`
// position
Position BasicImagePosition `json:"position,omitempty"`
// URL of image. HTTPS url is required.
// Max Length: 250
// Format: uri
URL strfmt.URI `json:"url,omitempty"`
}
BasicImage basic image swagger:model BasicImage
func (*BasicImage) MarshalBinary ¶
func (m *BasicImage) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BasicImage) UnmarshalBinary ¶
func (m *BasicImage) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BasicImagePosition ¶
type BasicImagePosition string
BasicImagePosition Position of where the image should be rendered within card. swagger:model BasicImagePosition
const ( // BasicImagePositionLEFT captures enum value "LEFT" BasicImagePositionLEFT BasicImagePosition = "LEFT" // BasicImagePositionCENTER captures enum value "CENTER" BasicImagePositionCENTER BasicImagePosition = "CENTER" // BasicImagePositionRIGHT captures enum value "RIGHT" BasicImagePositionRIGHT BasicImagePosition = "RIGHT" )
type BasicText ¶
type BasicText struct {
// Text to display.
// Max Length: 500
Content string `json:"content,omitempty"`
}
BasicText A text object. swagger:model BasicText
func (*BasicText) MarshalBinary ¶
MarshalBinary interface implementation
func (*BasicText) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type BasicTextButton ¶
type BasicTextButton struct {
// action
Action *Action `json:"action,omitempty"`
// The name of the button
// Max Length: 100
Name string `json:"name,omitempty"`
// position
Position BasicButtonPosition `json:"position,omitempty"`
}
BasicTextButton A text button definition for a basic template. swagger:model BasicTextButton
func (*BasicTextButton) MarshalBinary ¶
func (m *BasicTextButton) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BasicTextButton) UnmarshalBinary ¶
func (m *BasicTextButton) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BooleanSetting ¶
type BooleanSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
// Indicates if this input should refresh configs after a change in value.
SubmitOnChange *bool `json:"submitOnChange,omitempty"`
}
BooleanSetting Boolean Setting swagger:model BooleanSetting
func (*BooleanSetting) MarshalBinary ¶
func (m *BooleanSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (BooleanSetting) MarshalJSON ¶
func (m BooleanSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*BooleanSetting) UnmarshalBinary ¶
func (m *BooleanSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*BooleanSetting) UnmarshalJSON ¶
func (m *BooleanSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type ClientDetails ¶
type ClientDetails struct {
// 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)
// Max Length: 250
Language string `json:"language,omitempty"`
// The operating system of the client application initiating the request.
// Max Length: 16
Os string `json:"os,omitempty"`
// The version of the client application initiating the request.
// Max Length: 16
Version string `json:"version,omitempty"`
}
ClientDetails Known details about the client application from which the request was initiated. This information is provided on best effort basis. All properties maybe null or empty.
swagger:model ClientDetails
func (*ClientDetails) MarshalBinary ¶
func (m *ClientDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClientDetails) UnmarshalBinary ¶
func (m *ClientDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConfigEntries ¶
type ConfigEntries []*ConfigEntry
ConfigEntries A list of available configuration values. swagger:model ConfigEntries
type ConfigEntry ¶
type ConfigEntry struct {
// The config if valueType is DEVICE, meaningless otherwise
DeviceConfig *DeviceConfig `json:"deviceConfig,omitempty"`
// The config if valueType is MODE, meaningless otherwise
ModeConfig *ModeConfig `json:"modeConfig,omitempty"`
// The config if valueType is STRING, meaningless otherwise
StringConfig *StringConfig `json:"stringConfig,omitempty"`
// The value type.
// Enum: [STRING DEVICE MODE]
ValueType *string `json:"valueType,omitempty"`
}
ConfigEntry A configuration value type and the correspodning configuration. swagger:model ConfigEntry
func (*ConfigEntry) MarshalBinary ¶
func (m *ConfigEntry) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfigEntry) UnmarshalBinary ¶
func (m *ConfigEntry) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConfigMap ¶
type ConfigMap map[string]ConfigEntries
ConfigMap A map of configurations for an Installed App. The map 'key' is the configuration name and the 'value' is an array of strings.
swagger:model ConfigMap
type ConfigurationData ¶
type ConfigurationData struct {
// Settings currently configured by user.
Config ConfigMap `json:"config,omitempty"`
// The id of the installed app.
InstalledAppID string `json:"installedAppId,omitempty"`
// A developer defined page ID. Must be URL safe characters.
PageID string `json:"pageId,omitempty"`
// phase
// Required: true
Phase ConfigurationPhase `json:"phase"`
// The previous page the user completed. Must be URL safe characters.
PreviousPageID string `json:"previousPageId,omitempty"`
}
ConfigurationData A request for a pages flow to drive app installation. This will only be available for executions of type "CONFIGURATION".
swagger:model ConfigurationData
func (*ConfigurationData) MarshalBinary ¶
func (m *ConfigurationData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfigurationData) UnmarshalBinary ¶
func (m *ConfigurationData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConfigurationPhase ¶
type ConfigurationPhase string
ConfigurationPhase Denotes the current installation phase. swagger:model ConfigurationPhase
const ( // ConfigurationPhaseINITIALIZE captures enum value "INITIALIZE" ConfigurationPhaseINITIALIZE ConfigurationPhase = "INITIALIZE" // ConfigurationPhasePAGE captures enum value "PAGE" ConfigurationPhasePAGE ConfigurationPhase = "PAGE" )
type ConfigurationResponseData ¶
type ConfigurationResponseData struct {
// initialize
Initialize *InitializeSetting `json:"initialize,omitempty"`
// page
Page *Page `json:"page,omitempty"`
}
ConfigurationResponseData Expected response for a Configuration lifecycle execution. ConfigurationResponseData follows a compositional structure. * When a request is made for the INITIALIZE phase, a InitializeInstall model should be returned. * When a request is made for the PAGE phase, a Page model should be returned.
swagger:model ConfigurationResponseData
func (*ConfigurationResponseData) MarshalBinary ¶
func (m *ConfigurationResponseData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfigurationResponseData) UnmarshalBinary ¶
func (m *ConfigurationResponseData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DashboardCard ¶
type DashboardCard struct {
// basic v1
BasicV1 *BasicCard `json:"basicV1,omitempty"`
// A unique identifier for a card of service
// Required: true
CardID *string `json:"cardId"`
// free form
FreeForm *FreeFormCard `json:"freeForm,omitempty"`
// template Id
// Required: true
TemplateID DashboardCardTemplate `json:"templateId"`
}
DashboardCard payload of dashboard card swagger:model DashboardCard
func (*DashboardCard) MarshalBinary ¶
func (m *DashboardCard) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DashboardCard) UnmarshalBinary ¶
func (m *DashboardCard) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DashboardCardTemplate ¶
type DashboardCardTemplate string
DashboardCardTemplate A directive to the SmartThings client to use a specific template for rendering the dashboard card. Each card template may have a different set requirement for data needs.
* BASIC_V1 - The basic / default template. * FREE_FORM - A free form template with minimal constraints.
swagger:model DashboardCardTemplate
const ( // DashboardCardTemplateBASICV1 captures enum value "BASIC_V1" DashboardCardTemplateBASICV1 DashboardCardTemplate = "BASIC_V1" // DashboardCardTemplateFREEFORM captures enum value "FREE_FORM" DashboardCardTemplateFREEFORM DashboardCardTemplate = "FREE_FORM" )
type DashboardData ¶
type DashboardData struct {
// An OAuth token to use when calling into SmartThings API's.
// Required: true
AuthToken *string `json:"authToken"`
// installed app
// Required: true
InstalledApp *InstalledApp `json:"installedApp"`
}
DashboardData The data payload to an execution request with an AppLifecycle of DASHBOARD. swagger:model DashboardData
func (*DashboardData) MarshalBinary ¶
func (m *DashboardData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DashboardData) UnmarshalBinary ¶
func (m *DashboardData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DashboardResponseData ¶
type DashboardResponseData struct {
// list of card object
// Max Items: 5
// Min Items: 1
Cards []*DashboardCard `json:"cards"`
}
DashboardResponseData Expected response for a Dashboard lifecycle execution.
swagger:model DashboardResponseData
func (*DashboardResponseData) MarshalBinary ¶
func (m *DashboardResponseData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DashboardResponseData) UnmarshalBinary ¶
func (m *DashboardResponseData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DecimalSetting ¶
type DecimalSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
// The maximum inclusive value the decimal can be set to.
Max int64 `json:"max,omitempty"`
// The minumum inclusive value the decimal can be set to.
Min int64 `json:"min,omitempty"`
// A string to be shown after the text input field.
// Max Length: 10
PostMessage string `json:"postMessage,omitempty"`
}
DecimalSetting DECIMAL Setting swagger:model DecimalSetting
func (*DecimalSetting) MarshalBinary ¶
func (m *DecimalSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (DecimalSetting) MarshalJSON ¶
func (m DecimalSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*DecimalSetting) UnmarshalBinary ¶
func (m *DecimalSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*DecimalSetting) UnmarshalJSON ¶
func (m *DecimalSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type DeviceCommandsEvent ¶
type DeviceCommandsEvent struct {
// commands
Commands []*DeviceCommandsEventCommand `json:"commands"`
// The guid of the device that the cammands are for.
DeviceID string `json:"deviceId,omitempty"`
// The external ID that was set during install of a device.
ExternalID string `json:"externalId,omitempty"`
// The device profile ID of the device instance.
ProfileID string `json:"profileId,omitempty"`
}
DeviceCommandsEvent An event that contains commands for devices that were created by this app. swagger:model DeviceCommandsEvent
func (*DeviceCommandsEvent) MarshalBinary ¶
func (m *DeviceCommandsEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceCommandsEvent) UnmarshalBinary ¶
func (m *DeviceCommandsEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceCommandsEventCommand ¶
type DeviceCommandsEventCommand struct {
// arguments
Arguments []interface{} `json:"arguments"`
// capability
Capability string `json:"capability,omitempty"`
// command
Command string `json:"command,omitempty"`
// component Id
ComponentID string `json:"componentId,omitempty"`
}
DeviceCommandsEventCommand device commands event command swagger:model DeviceCommandsEventCommand
func (*DeviceCommandsEventCommand) MarshalBinary ¶
func (m *DeviceCommandsEventCommand) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceCommandsEventCommand) UnmarshalBinary ¶
func (m *DeviceCommandsEventCommand) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceConfig ¶
type DeviceConfig struct {
// The component ID on the device.
ComponentID string `json:"componentId,omitempty"`
// The ID of the device.
DeviceID string `json:"deviceId,omitempty"`
}
DeviceConfig A device configuration. swagger:model DeviceConfig
func (*DeviceConfig) MarshalBinary ¶
func (m *DeviceConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceConfig) UnmarshalBinary ¶
func (m *DeviceConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceEvent ¶
type DeviceEvent struct {
// The name of the DEVICE_EVENT. This typically corresponds to an attribute name of the device-handler’s capabilities.
Attribute string `json:"attribute,omitempty"`
// The name of the capability associated with the DEVICE_EVENT.
Capability string `json:"capability,omitempty"`
// The name of the component on the device that the event is associated with.
ComponentID string `json:"componentId,omitempty"`
// The ID of the device associated with the DEVICE_EVENT.
DeviceID string `json:"deviceId,omitempty"`
// The ID of the event.
EventID string `json:"eventId,omitempty"`
// The ID of the location in which the event was triggered.
LocationID string `json:"locationId,omitempty"`
// Whether or not the state of the device has changed as a result of the DEVICE_EVENT.
StateChange bool `json:"stateChange,omitempty"`
// The name of subscription that caused delivery.
SubscriptionName string `json:"subscriptionName,omitempty"`
// The value of the event. The type of the value is dependent on the capability's attribute type.
//
Value interface{} `json:"value,omitempty"`
}
DeviceEvent An event on a device that matched a subscription for this app. swagger:model DeviceEvent
func (*DeviceEvent) MarshalBinary ¶
func (m *DeviceEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceEvent) UnmarshalBinary ¶
func (m *DeviceEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceHealthEvent ¶
type DeviceHealthEvent struct {
// The id of the device.
DeviceID string `json:"deviceId,omitempty"`
// The id of the event.
EventID string `json:"eventId,omitempty"`
// The id of the hub.
HubID string `json:"hubId,omitempty"`
// The id of the location in which the event was triggered.
LocationID string `json:"locationId,omitempty"`
// The reason the device is offline.
//
// Enum: [NONE SERVICE_UNAVAILABLE HUB_OFFLINE ZWAVE_OFFLINE ZIGBEE_OFFLINE BLUETOOTH_OFFLINE HUB_DISCONNECTED]
Reason string `json:"reason,omitempty"`
// The status of the device.
//
// Enum: [OFFLINE ONLINE UNHEALTHY]
Status string `json:"status,omitempty"`
}
DeviceHealthEvent An event that represents a change in the health of the a device. swagger:model DeviceHealthEvent
func (*DeviceHealthEvent) MarshalBinary ¶
func (m *DeviceHealthEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceHealthEvent) UnmarshalBinary ¶
func (m *DeviceHealthEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceLifecycle ¶
type DeviceLifecycle string
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.
swagger:model DeviceLifecycle
const ( // DeviceLifecycleCREATE captures enum value "CREATE" DeviceLifecycleCREATE DeviceLifecycle = "CREATE" // DeviceLifecycleDELETE captures enum value "DELETE" DeviceLifecycleDELETE DeviceLifecycle = "DELETE" // DeviceLifecycleUPDATE captures enum value "UPDATE" DeviceLifecycleUPDATE DeviceLifecycle = "UPDATE" // DeviceLifecycleMOVEFROM captures enum value "MOVE_FROM" DeviceLifecycleMOVEFROM DeviceLifecycle = "MOVE_FROM" // DeviceLifecycleMOVETO captures enum value "MOVE_TO" DeviceLifecycleMOVETO DeviceLifecycle = "MOVE_TO" )
type DeviceLifecycleCreate ¶
type DeviceLifecycleCreate interface{}
DeviceLifecycleCreate Create device lifecycle.
swagger:model DeviceLifecycleCreate
type DeviceLifecycleDelete ¶
type DeviceLifecycleDelete interface{}
DeviceLifecycleDelete Delete device lifecycle.
swagger:model DeviceLifecycleDelete
type DeviceLifecycleEvent ¶
type DeviceLifecycleEvent struct {
// create
Create DeviceLifecycleCreate `json:"create,omitempty"`
// delete
Delete DeviceLifecycleDelete `json:"delete,omitempty"`
// The id of the device.
DeviceID string `json:"deviceId,omitempty"`
// The name of the device
DeviceName string `json:"deviceName,omitempty"`
// The id of the event.
EventID string `json:"eventId,omitempty"`
// lifecycle
Lifecycle DeviceLifecycle `json:"lifecycle,omitempty"`
// The id of the location in which the event was triggered.
LocationID string `json:"locationId,omitempty"`
// move from
MoveFrom *DeviceLifecycleMove `json:"moveFrom,omitempty"`
// move to
MoveTo *DeviceLifecycleMove `json:"moveTo,omitempty"`
// The principal that made the change
Principal string `json:"principal,omitempty"`
// update
Update DeviceLifecycleUpdate `json:"update,omitempty"`
}
DeviceLifecycleEvent A device lifecycle event. swagger:model DeviceLifecycleEvent
func (*DeviceLifecycleEvent) MarshalBinary ¶
func (m *DeviceLifecycleEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceLifecycleEvent) UnmarshalBinary ¶
func (m *DeviceLifecycleEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceLifecycleMove ¶
type DeviceLifecycleMove struct {
// location Id
LocationID string `json:"locationId,omitempty"`
}
DeviceLifecycleMove Move device lifecycle.
swagger:model DeviceLifecycleMove
func (*DeviceLifecycleMove) MarshalBinary ¶
func (m *DeviceLifecycleMove) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceLifecycleMove) UnmarshalBinary ¶
func (m *DeviceLifecycleMove) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceLifecycleUpdate ¶
type DeviceLifecycleUpdate interface{}
DeviceLifecycleUpdate Update device lifecycle.
swagger:model DeviceLifecycleUpdate
type DeviceSetting ¶
type DeviceSetting struct {
SectionSetting
// The required capabilities for the device(s) options.
Capabilities []string `json:"capabilities"`
// Indicates if this device setting can have multiple values.
Multiple *bool `json:"multiple,omitempty"`
// The required permissions for the selected device(s).
Permissions []string `json:"permissions"`
// Indicates if the first device in the list of options should be pre selected.
Preselect *bool `json:"preselect,omitempty"`
// style
Style StyleType `json:"style,omitempty"`
// Indicates if this input should refresh configs after a change in value.
SubmitOnChange *bool `json:"submitOnChange,omitempty"`
}
DeviceSetting Device Setting swagger:model DeviceSetting
func (*DeviceSetting) MarshalBinary ¶
func (m *DeviceSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (DeviceSetting) MarshalJSON ¶
func (m DeviceSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*DeviceSetting) UnmarshalBinary ¶
func (m *DeviceSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*DeviceSetting) UnmarshalJSON ¶
func (m *DeviceSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type EmailSetting ¶
type EmailSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
}
EmailSetting Email Setting swagger:model EmailSetting
func (*EmailSetting) MarshalBinary ¶
func (m *EmailSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (EmailSetting) MarshalJSON ¶
func (m EmailSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*EmailSetting) UnmarshalBinary ¶
func (m *EmailSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*EmailSetting) UnmarshalJSON ¶
func (m *EmailSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type EnumSetting ¶
type EnumSetting struct {
SectionSetting
// Display the enum options as groups.
GroupedOptions []*GroupedOption `json:"groupedOptions"`
// Indicates if this enum setting can have multiple values.
Multiple *bool `json:"multiple,omitempty"`
// The enum options.
Options []*Option `json:"options"`
// style
Style StyleType `json:"style,omitempty"`
// Indicates if this input should refresh configs after a change in value.
SubmitOnChange *bool `json:"submitOnChange,omitempty"`
}
EnumSetting Enum Setting swagger:model EnumSetting
func (*EnumSetting) MarshalBinary ¶
func (m *EnumSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (EnumSetting) MarshalJSON ¶
func (m EnumSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*EnumSetting) UnmarshalBinary ¶
func (m *EnumSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*EnumSetting) UnmarshalJSON ¶
func (m *EnumSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type EnumStyleType ¶
type EnumStyleType string
EnumStyleType Style of the setting. swagger:model EnumStyleType
const ( // EnumStyleTypeCOMPLETE captures enum value "COMPLETE" EnumStyleTypeCOMPLETE EnumStyleType = "COMPLETE" // EnumStyleTypeERROR captures enum value "ERROR" EnumStyleTypeERROR EnumStyleType = "ERROR" // EnumStyleTypeDEFAULT captures enum value "DEFAULT" EnumStyleTypeDEFAULT EnumStyleType = "DEFAULT" // EnumStyleTypeDROPDOWN captures enum value "DROPDOWN" EnumStyleTypeDROPDOWN EnumStyleType = "DROPDOWN" )
type Event ¶
type Event struct {
// device commands event
DeviceCommandsEvent *DeviceCommandsEvent `json:"deviceCommandsEvent,omitempty"`
// device event
DeviceEvent *DeviceEvent `json:"deviceEvent,omitempty"`
// event type
EventType EventType `json:"eventType,omitempty"`
// mode event
ModeEvent *ModeEvent `json:"modeEvent,omitempty"`
// timer event
TimerEvent *TimerEvent `json:"timerEvent,omitempty"`
}
Event The event information, only populated if the execution type is EVENT. swagger:model Event
func (*Event) MarshalBinary ¶
MarshalBinary interface implementation
func (*Event) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type EventData ¶
type EventData struct {
// An OAuth token to use when calling into SmartThings API's.
// Required: true
AuthToken *string `json:"authToken"`
// events
Events []*Event `json:"events"`
// installed app
// Required: true
InstalledApp *InstalledApp `json:"installedApp"`
}
EventData The data payload to an execution request with an AppLifecycle of EVENT. swagger:model EventData
func (*EventData) MarshalBinary ¶
MarshalBinary interface implementation
func (*EventData) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type EventResponseData ¶
type EventResponseData interface{}
EventResponseData Empty object response for an Event lifecycle execution.
swagger:model EventResponseData
type EventType ¶
type EventType string
EventType The type of event passed to the app being executed. The type will be one of:
- DEVICE_EVENT - A device event as a result of a subscription the app created.
- TIMER_EVENT - An event as a result of a scheduled app execution.
- DEVICE_COMMANDS_EVENT - _Only applicable for cloud-to-cloud device integration apps._ An event as a result of a device command execution request.
- MODE_EVENT - A mode event is triggered when the location's mode is changed.
swagger:model EventType
const ( // EventTypeDEVICEEVENT captures enum value "DEVICE_EVENT" EventTypeDEVICEEVENT EventType = "DEVICE_EVENT" // EventTypeMODEEVENT captures enum value "MODE_EVENT" EventTypeMODEEVENT EventType = "MODE_EVENT" // EventTypeTIMEREVENT captures enum value "TIMER_EVENT" EventTypeTIMEREVENT EventType = "TIMER_EVENT" // EventTypeDEVICECOMMANDSEVENT captures enum value "DEVICE_COMMANDS_EVENT" EventTypeDEVICECOMMANDSEVENT EventType = "DEVICE_COMMANDS_EVENT" )
type ExecuteAction ¶
type ExecuteAction struct {
// An arbitrary map of input parameters which the SmartApp can use to build a custom response.
Parameters map[string]string `json:"parameters,omitempty"`
}
ExecuteAction Call the EXECUTE lifecycle on the backing SmartApp. swagger:model ExecuteAction
func (*ExecuteAction) MarshalBinary ¶
func (m *ExecuteAction) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExecuteAction) UnmarshalBinary ¶
func (m *ExecuteAction) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ExecutionRequest ¶
type ExecutionRequest struct {
// configuration data
ConfigurationData *ConfigurationData `json:"configurationData,omitempty"`
// event data
EventData *EventData `json:"eventData,omitempty"`
// This is a correlation id that is assigned to the execution that is useful for support requests.
// Format: uuid
ExecutionID strfmt.UUID `json:"executionId,omitempty"`
// install data
InstallData *InstallData `json:"installData,omitempty"`
// lifecycle
Lifecycle AppLifecycle `json:"lifecycle,omitempty"`
// An IETF BCP 47 language tag representing the chosen locale for this account.
Locale string `json:"locale,omitempty"`
// oauth callback data
OauthCallbackData *OAuthCallbackData `json:"oauthCallbackData,omitempty"`
// ping data
PingData *PingData `json:"pingData,omitempty"`
// Global settings as defined on the App.
Settings map[string]string `json:"settings,omitempty"`
// uninstall data
UninstallData *UninstallData `json:"uninstallData,omitempty"`
// update data
UpdateData *UpdateData `json:"updateData,omitempty"`
// The version of the execution's request model.
Version string `json:"version,omitempty"`
}
ExecutionRequest The root model for all executions. An execution request is compositional in nature. Client's can expect exactly one *Data field set depending on the type of execution. For example, if execution is of type EVENT, the "eventData" field will be set.
swagger:model ExecutionRequest
func (*ExecutionRequest) MarshalBinary ¶
func (m *ExecutionRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExecutionRequest) UnmarshalBinary ¶
func (m *ExecutionRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ExecutionResponse ¶
type ExecutionResponse struct {
// configuration data
ConfigurationData *ConfigurationResponseData `json:"configurationData,omitempty"`
// event data
EventData EventResponseData `json:"eventData,omitempty"`
// install data
InstallData InstallResponseData `json:"installData,omitempty"`
// oauth callback data
OauthCallbackData OAuthCallbackResponseData `json:"oauthCallbackData,omitempty"`
// ping data
PingData *PingResponseData `json:"pingData,omitempty"`
// status code
StatusCode int64 `json:"statusCode,omitempty"`
// uninstall data
UninstallData UninstallResponseData `json:"uninstallData,omitempty"`
// update data
UpdateData UpdateResponseData `json:"updateData,omitempty"`
}
ExecutionResponse Expected response structure for an SmartApp execution. An execution response is compositional in nature. Client's should set exactly one *Data field depending on the type of execution. For example, if the execution request's lifecycle was of type EVENT, the "eventData" field should be returned.
swagger:model ExecutionResponse
func (*ExecutionResponse) MarshalBinary ¶
func (m *ExecutionResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExecutionResponse) UnmarshalBinary ¶
func (m *ExecutionResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FreeFormCard ¶
type FreeFormCard struct {
// An arbitrary set of key / value pairs useful for passing any custom metadata.
//
// * Supports a maximum of 5 entries.
// * Maximum key length: 36 Unicode characters in UTF-8
// * Maximum value length: 1000 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.
//
Attributes map[string]string `json:"attributes,omitempty"`
}
FreeFormCard free form card swagger:model FreeFormCard
func (*FreeFormCard) MarshalBinary ¶
func (m *FreeFormCard) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FreeFormCard) UnmarshalBinary ¶
func (m *FreeFormCard) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GroupedOption ¶
type GroupedOption struct {
// The display name of this group of enum options.
// Max Length: 128
Name string `json:"name,omitempty"`
// The enum options.
Options []*Option `json:"options"`
}
GroupedOption grouped option swagger:model GroupedOption
func (*GroupedOption) MarshalBinary ¶
func (m *GroupedOption) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GroupedOption) UnmarshalBinary ¶
func (m *GroupedOption) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageSetting ¶
type ImageSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
}
ImageSetting Image Setting swagger:model ImageSetting
func (*ImageSetting) MarshalBinary ¶
func (m *ImageSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ImageSetting) MarshalJSON ¶
func (m ImageSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*ImageSetting) UnmarshalBinary ¶
func (m *ImageSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ImageSetting) UnmarshalJSON ¶
func (m *ImageSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type ImagesSetting ¶
type ImagesSetting struct {
SectionSetting
// The images to display.
Images []string `json:"images"`
}
ImagesSetting Images Setting swagger:model ImagesSetting
func (*ImagesSetting) MarshalBinary ¶
func (m *ImagesSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ImagesSetting) MarshalJSON ¶
func (m ImagesSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*ImagesSetting) UnmarshalBinary ¶
func (m *ImagesSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ImagesSetting) UnmarshalJSON ¶
func (m *ImagesSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type InitializeSetting ¶
type InitializeSetting struct {
Setting
// Disable the ability for the user to customize the display name.
DisableCustomDisplayName *bool `json:"disableCustomDisplayName,omitempty"`
// Disable the ability to remove the app from the configuration flow.
DisableRemoveApp *bool `json:"disableRemoveApp,omitempty"`
// A developer defined page ID of the first page to display. Must be URL safe characters.
FirstPageID string `json:"firstPageId,omitempty"`
// permissions
Permissions []string `json:"permissions"`
}
InitializeSetting The initial setting to be returned when starting a new configuration install. swagger:model InitializeSetting
func (*InitializeSetting) MarshalBinary ¶
func (m *InitializeSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (InitializeSetting) MarshalJSON ¶
func (m InitializeSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*InitializeSetting) UnmarshalBinary ¶
func (m *InitializeSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*InitializeSetting) UnmarshalJSON ¶
func (m *InitializeSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type InstallData ¶
type InstallData struct {
// An OAuth token to use when calling into SmartThings API's.
// Required: true
AuthToken *string `json:"authToken"`
// installed app
// Required: true
InstalledApp *InstalledApp `json:"installedApp"`
// A refresh token which maybe used to obtain authorization to SmartThings API after expiration of the authToken.
// An integration will need to use this refreshToken to support calling the SmartThings API outside the context
// of an event.
//
// Required: true
RefreshToken *string `json:"refreshToken"`
}
InstallData The data payload to an execution request with an AppLifecycle of INSTALL. swagger:model InstallData
func (*InstallData) MarshalBinary ¶
func (m *InstallData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InstallData) UnmarshalBinary ¶
func (m *InstallData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InstallResponseData ¶
type InstallResponseData interface{}
InstallResponseData Empty object response for an Install lifecycle execution.
swagger:model InstallResponseData
type InstalledApp ¶
type InstalledApp struct {
// config
Config ConfigMap `json:"config,omitempty"`
// The id of the installed app.
// Format: uuid
InstalledAppID strfmt.UUID `json:"installedAppId,omitempty"`
// The location that the installed App is associated with
LocationID string `json:"locationId,omitempty"`
// permissions
Permissions Permissions `json:"permissions"`
}
InstalledApp The information associated with this installed app. swagger:model InstalledApp
func (*InstalledApp) MarshalBinary ¶
func (m *InstalledApp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InstalledApp) UnmarshalBinary ¶
func (m *InstalledApp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LaunchPluginAction ¶
type LaunchPluginAction struct {
// The ID of the plugin to launch.
PluginID string `json:"pluginId,omitempty"`
}
LaunchPluginAction Launch a backing UI plugin in SmartThings Client. swagger:model LaunchPluginAction
func (*LaunchPluginAction) MarshalBinary ¶
func (m *LaunchPluginAction) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LaunchPluginAction) UnmarshalBinary ¶
func (m *LaunchPluginAction) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinkSetting ¶
type LinkSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
// style
Style StyleType `json:"style,omitempty"`
// The page to navigate to.
// Max Length: 2048
URL string `json:"url,omitempty"`
}
LinkSetting URL link Setting swagger:model LinkSetting
func (*LinkSetting) MarshalBinary ¶
func (m *LinkSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (LinkSetting) MarshalJSON ¶
func (m LinkSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*LinkSetting) UnmarshalBinary ¶
func (m *LinkSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*LinkSetting) UnmarshalJSON ¶
func (m *LinkSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type LinkStyleType ¶
type LinkStyleType string
LinkStyleType Style of the setting. swagger:model LinkStyleType
const ( // LinkStyleTypeCOMPLETE captures enum value "COMPLETE" LinkStyleTypeCOMPLETE LinkStyleType = "COMPLETE" // LinkStyleTypeERROR captures enum value "ERROR" LinkStyleTypeERROR LinkStyleType = "ERROR" // LinkStyleTypeDEFAULT captures enum value "DEFAULT" LinkStyleTypeDEFAULT LinkStyleType = "DEFAULT" // LinkStyleTypeBUTTON captures enum value "BUTTON" LinkStyleTypeBUTTON LinkStyleType = "BUTTON" )
type ModeConfig ¶
type ModeConfig struct {
// The ID of the mode.
ModeID string `json:"modeId,omitempty"`
}
ModeConfig A mode configuration. swagger:model ModeConfig
func (*ModeConfig) MarshalBinary ¶
func (m *ModeConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ModeConfig) UnmarshalBinary ¶
func (m *ModeConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ModeEvent ¶
type ModeEvent struct {
// The ID of the mode associated with a MODE_EVENT.
ModeID string `json:"modeId,omitempty"`
}
ModeEvent mode event swagger:model ModeEvent
func (*ModeEvent) MarshalBinary ¶
MarshalBinary interface implementation
func (*ModeEvent) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ModeSetting ¶
type ModeSetting struct {
SectionSetting
// Indicates if this enum setting can have multiple values.
Multiple *bool `json:"multiple,omitempty"`
// style
Style StyleType `json:"style,omitempty"`
// Indicates if this input should refresh configs after a change in value.
SubmitOnChange *bool `json:"submitOnChange,omitempty"`
}
ModeSetting Mode Setting swagger:model ModeSetting
func (*ModeSetting) MarshalBinary ¶
func (m *ModeSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ModeSetting) MarshalJSON ¶
func (m ModeSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*ModeSetting) UnmarshalBinary ¶
func (m *ModeSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ModeSetting) UnmarshalJSON ¶
func (m *ModeSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type NumberSetting ¶
type NumberSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
// The maximum inclusive value the number can be set to.
Max int64 `json:"max,omitempty"`
// The minumum inclusive value the number can be set to.
Min int64 `json:"min,omitempty"`
// A string to be shown after the text input field.
// Max Length: 10
PostMessage string `json:"postMessage,omitempty"`
}
NumberSetting Number Setting swagger:model NumberSetting
func (*NumberSetting) MarshalBinary ¶
func (m *NumberSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (NumberSetting) MarshalJSON ¶
func (m NumberSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*NumberSetting) UnmarshalBinary ¶
func (m *NumberSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*NumberSetting) UnmarshalJSON ¶
func (m *NumberSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type OAuthCallbackData ¶
type OAuthCallbackData struct {
// The id of the installed app.
InstalledAppID string `json:"installedAppId,omitempty"`
// A relative URL containing all of the query string parameters as returned by the third party oauth system. A SmartApp can
// parse the `urlPath` property to extract any senstive auth codes/tokens which can then be used to access the third party system.
//
URLPath string `json:"urlPath,omitempty"`
}
OAuthCallbackData Provides intergration with the result of a third party oauth attempt. This will only be available for executions of type "OAUTH_CALLBACK".
swagger:model OAuthCallbackData
func (*OAuthCallbackData) MarshalBinary ¶
func (m *OAuthCallbackData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OAuthCallbackData) UnmarshalBinary ¶
func (m *OAuthCallbackData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OAuthCallbackResponseData ¶
type OAuthCallbackResponseData interface{}
OAuthCallbackResponseData Empty object response for an OAuth Callback lifecycle execution.
swagger:model OAuthCallbackResponseData
type OAuthSetting ¶
type OAuthSetting struct {
SectionSetting
// style
Style StyleType `json:"style,omitempty"`
// The url to use for the OAuth service.
// Use __SmartThingsOAuthCallback__ in the template for the callback/redirect url you need to provide to the OAuth service.
//
// Max Length: 2048
URLTemplate string `json:"urlTemplate,omitempty"`
}
OAuthSetting OAuth Setting swagger:model OAuthSetting
func (*OAuthSetting) MarshalBinary ¶
func (m *OAuthSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (OAuthSetting) MarshalJSON ¶
func (m OAuthSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*OAuthSetting) UnmarshalBinary ¶
func (m *OAuthSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*OAuthSetting) UnmarshalJSON ¶
func (m *OAuthSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type Option ¶
type Option struct {
// The unique ID for this option.
// Max Length: 128
ID string `json:"id,omitempty"`
// The display name for this option.
// Max Length: 128
Name string `json:"name,omitempty"`
}
Option option swagger:model Option
func (*Option) MarshalBinary ¶
MarshalBinary interface implementation
func (*Option) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Page ¶
type Page struct {
// Indicates if this is the last page in the configuration process.
Complete *bool `json:"complete,omitempty"`
// Name of the page to be configured.
// Max Length: 128
Name string `json:"name,omitempty"`
// A developer defined page ID for the next page in the configuration process. Must be URL safe characters.
NextPageID string `json:"nextPageId,omitempty"`
// A developer defined page ID. Must be URL safe characters.
PageID string `json:"pageId,omitempty"`
// A developer defined page ID for the previous page in the configuration process. Must be URL safe characters.
PreviousPageID string `json:"previousPageId,omitempty"`
// The display sections for user defined settings.
Sections []*Section `json:"sections"`
}
Page page swagger:model Page
func (*Page) MarshalBinary ¶
MarshalBinary interface implementation
func (*Page) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PageSetting ¶
type PageSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
// The page to navigate to.
// Max Length: 128
Page string `json:"page,omitempty"`
// style
Style StyleType `json:"style,omitempty"`
}
PageSetting Jump to page Setting swagger:model PageSetting
func (*PageSetting) MarshalBinary ¶
func (m *PageSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (PageSetting) MarshalJSON ¶
func (m PageSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*PageSetting) UnmarshalBinary ¶
func (m *PageSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*PageSetting) UnmarshalJSON ¶
func (m *PageSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type ParagraphSetting ¶
type ParagraphSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
}
ParagraphSetting Paragraph Setting swagger:model ParagraphSetting
func (*ParagraphSetting) MarshalBinary ¶
func (m *ParagraphSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ParagraphSetting) MarshalJSON ¶
func (m ParagraphSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*ParagraphSetting) UnmarshalBinary ¶
func (m *ParagraphSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ParagraphSetting) UnmarshalJSON ¶
func (m *ParagraphSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type PasswordSetting ¶
type PasswordSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
// The maximum length the password can have.
MaxLength int64 `json:"maxLength,omitempty"`
// The minimum length the password can have.
MinLength int64 `json:"minLength,omitempty"`
}
PasswordSetting Password Setting swagger:model PasswordSetting
func (*PasswordSetting) MarshalBinary ¶
func (m *PasswordSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (PasswordSetting) MarshalJSON ¶
func (m PasswordSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*PasswordSetting) UnmarshalBinary ¶
func (m *PasswordSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*PasswordSetting) UnmarshalJSON ¶
func (m *PasswordSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type Permissions ¶
type Permissions []string
Permissions A list of permissions associated with this execution. See `securityDefinitions` for more information. swagger:model Permissions
type PhoneSetting ¶
type PhoneSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
}
PhoneSetting Phone Setting swagger:model PhoneSetting
func (*PhoneSetting) MarshalBinary ¶
func (m *PhoneSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (PhoneSetting) MarshalJSON ¶
func (m PhoneSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*PhoneSetting) UnmarshalBinary ¶
func (m *PhoneSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*PhoneSetting) UnmarshalJSON ¶
func (m *PhoneSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type PingData ¶
type PingData struct {
// A challenge phrase that the SmartApp must echo back to validate itself.
// Required: true
Challenge *string `json:"challenge"`
}
PingData A request to ping a SmartApp to ensure connectivity.
swagger:model PingData
func (*PingData) MarshalBinary ¶
MarshalBinary interface implementation
func (*PingData) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PingResponseData ¶
type PingResponseData struct {
// An echo of the challenge that was provided on the request.
Challenge string `json:"challenge,omitempty"`
}
PingResponseData Expected response for a Ping lifecycle execution.
swagger:model PingResponseData
func (*PingResponseData) MarshalBinary ¶
func (m *PingResponseData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PingResponseData) UnmarshalBinary ¶
func (m *PingResponseData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneConfig ¶
type SceneConfig struct {
// The ID of the scene.
SceneID string `json:"sceneId,omitempty"`
}
SceneConfig A scene configuration. swagger:model SceneConfig
func (*SceneConfig) MarshalBinary ¶
func (m *SceneConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneConfig) UnmarshalBinary ¶
func (m *SceneConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneLifecycle ¶
type SceneLifecycle string
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.
swagger:model SceneLifecycle
const ( // SceneLifecycleCREATE captures enum value "CREATE" SceneLifecycleCREATE SceneLifecycle = "CREATE" // SceneLifecycleUPDATE captures enum value "UPDATE" SceneLifecycleUPDATE SceneLifecycle = "UPDATE" // SceneLifecycleDELETE captures enum value "DELETE" SceneLifecycleDELETE SceneLifecycle = "DELETE" )
type SceneLifecycleCreate ¶
type SceneLifecycleCreate interface{}
SceneLifecycleCreate Create scene lifecycle.
swagger:model SceneLifecycleCreate
type SceneLifecycleDelete ¶
type SceneLifecycleDelete interface{}
SceneLifecycleDelete Delete scene lifecycle.
swagger:model SceneLifecycleDelete
type SceneLifecycleEvent ¶
type SceneLifecycleEvent struct {
// create
Create SceneLifecycleCreate `json:"create,omitempty"`
// delete
Delete SceneLifecycleDelete `json:"delete,omitempty"`
// The id of the event.
EventID string `json:"eventId,omitempty"`
// lifecycle
Lifecycle SceneLifecycle `json:"lifecycle,omitempty"`
// The id of the location in which the event was triggered.
LocationID string `json:"locationId,omitempty"`
// The id of the scene.
SceneID string `json:"sceneId,omitempty"`
// update
Update SceneLifecycleUpdate `json:"update,omitempty"`
}
SceneLifecycleEvent A scene lifecycle event. swagger:model SceneLifecycleEvent
func (*SceneLifecycleEvent) MarshalBinary ¶
func (m *SceneLifecycleEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneLifecycleEvent) UnmarshalBinary ¶
func (m *SceneLifecycleEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneLifecycleUpdate ¶
type SceneLifecycleUpdate interface{}
SceneLifecycleUpdate Update scene lifecycle.
swagger:model SceneLifecycleUpdate
type SceneSetting ¶
type SceneSetting struct {
SectionSetting
// Indicates if this scene setting can have multiple values.
Multiple *bool `json:"multiple,omitempty"`
// style
Style StyleType `json:"style,omitempty"`
// Indicates if this input should refresh configs after a change in value.
SubmitOnChange *bool `json:"submitOnChange,omitempty"`
}
SceneSetting Scene Setting swagger:model SceneSetting
func (*SceneSetting) MarshalBinary ¶
func (m *SceneSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (SceneSetting) MarshalJSON ¶
func (m SceneSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*SceneSetting) UnmarshalBinary ¶
func (m *SceneSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*SceneSetting) UnmarshalJSON ¶
func (m *SceneSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type Section ¶
type Section struct {
// If section can be collapsed, whether or not it defaults to hidden
Hidden *bool `json:"hidden,omitempty"`
// Whether or not the section can be collapsed
Hideable *bool `json:"hideable,omitempty"`
// Name of the section.
// Max Length: 128
Name string `json:"name,omitempty"`
// Configuration settings represent the questions asked to the end user installing an integration the answers to
// which provide the configuration for which the integration will use when executing. Settings follow an inheritance
// pattern. The type field dictates the expected instance of setting that is provided.
//
Settings []*SectionSetting `json:"settings"`
}
Section section swagger:model Section
func (*Section) MarshalBinary ¶
MarshalBinary interface implementation
func (*Section) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SectionSetting ¶
type SectionSetting struct {
Setting
// A defualt value for the setting.
// Max Length: 128
DefaultValue string `json:"defaultValue,omitempty"`
// Indicates if this setting is required for configuration.
Required *bool `json:"required,omitempty"`
// type
// Required: true
Type SettingType `json:"type"`
}
SectionSetting section setting swagger:model SectionSetting
func (*SectionSetting) MarshalBinary ¶
func (m *SectionSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (SectionSetting) MarshalJSON ¶
func (m SectionSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*SectionSetting) UnmarshalBinary ¶
func (m *SectionSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*SectionSetting) UnmarshalJSON ¶
func (m *SectionSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type SecurityArmStateEvent ¶
type SecurityArmStateEvent struct {
// The arm state of a security system.
//
// Enum: [UNKNOWN ARMED_STAY ARMED_AWAY DISARMED]
ArmState string `json:"armState,omitempty"`
// The id of the event.
EventID string `json:"eventId,omitempty"`
// The id of the location in which the event was triggered.
LocationID string `json:"locationId,omitempty"`
// A set of key / value pairs useful for passing any optional arguments.
//
OptionalArguments map[string]SimpleValue `json:"optionalArguments,omitempty"`
}
SecurityArmStateEvent An event that represents a change in the arm state of a security system.
swagger:model SecurityArmStateEvent
func (*SecurityArmStateEvent) MarshalBinary ¶
func (m *SecurityArmStateEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecurityArmStateEvent) UnmarshalBinary ¶
func (m *SecurityArmStateEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Setting ¶
type Setting struct {
// Description of the app to be configured.
// Max Length: 2048
Description string `json:"description,omitempty"`
// A developer defined configuration ID.
// Max Length: 128
ID string `json:"id,omitempty"`
// Name of the setting to be configured.
// Max Length: 128
Name string `json:"name,omitempty"`
}
Setting setting swagger:model Setting
func (*Setting) MarshalBinary ¶
MarshalBinary interface implementation
func (*Setting) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SettingType ¶
type SettingType string
SettingType Denotes the type of setting. swagger:model SettingType
const ( // SettingTypeDEVICE captures enum value "DEVICE" SettingTypeDEVICE SettingType = "DEVICE" // SettingTypeTEXT captures enum value "TEXT" SettingTypeTEXT SettingType = "TEXT" // SettingTypePASSWORD captures enum value "PASSWORD" SettingTypePASSWORD SettingType = "PASSWORD" // SettingTypeBOOLEAN captures enum value "BOOLEAN" SettingTypeBOOLEAN SettingType = "BOOLEAN" // SettingTypeENUM captures enum value "ENUM" SettingTypeENUM SettingType = "ENUM" // SettingTypeMODE captures enum value "MODE" SettingTypeMODE SettingType = "MODE" // SettingTypeSCENE captures enum value "SCENE" SettingTypeSCENE SettingType = "SCENE" // SettingTypeLINK captures enum value "LINK" SettingTypeLINK SettingType = "LINK" // SettingTypePAGE captures enum value "PAGE" SettingTypePAGE SettingType = "PAGE" // SettingTypeIMAGE captures enum value "IMAGE" SettingTypeIMAGE SettingType = "IMAGE" // SettingTypeIMAGES captures enum value "IMAGES" SettingTypeIMAGES SettingType = "IMAGES" // SettingTypeVIDEO captures enum value "VIDEO" SettingTypeVIDEO SettingType = "VIDEO" // SettingTypeTIME captures enum value "TIME" SettingTypeTIME SettingType = "TIME" // SettingTypePARAGRAPH captures enum value "PARAGRAPH" SettingTypePARAGRAPH SettingType = "PARAGRAPH" // SettingTypeEMAIL captures enum value "EMAIL" SettingTypeEMAIL SettingType = "EMAIL" // SettingTypeDECIMAL captures enum value "DECIMAL" SettingTypeDECIMAL SettingType = "DECIMAL" // SettingTypeNUMBER captures enum value "NUMBER" SettingTypeNUMBER SettingType = "NUMBER" // SettingTypePHONE captures enum value "PHONE" SettingTypePHONE SettingType = "PHONE" // SettingTypeOAUTH captures enum value "OAUTH" SettingTypeOAUTH SettingType = "OAUTH" )
type SimpleValue ¶
type SimpleValue struct {
// bool value
BoolValue bool `json:"boolValue,omitempty"`
// double value
DoubleValue float64 `json:"doubleValue,omitempty"`
// int value
IntValue int64 `json:"intValue,omitempty"`
// string value
StringValue string `json:"stringValue,omitempty"`
// The type of the value.
//
// Enum: [NULL_VALUE INT_VALUE DOUBLE_VALUE STRING_VALUE BOOLEAN_VALUE]
ValueType string `json:"valueType,omitempty"`
}
SimpleValue A simple value. swagger:model SimpleValue
func (*SimpleValue) MarshalBinary ¶
func (m *SimpleValue) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SimpleValue) UnmarshalBinary ¶
func (m *SimpleValue) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StringConfig ¶
type StringConfig struct {
// A config value
// Max Length: 2048
Value string `json:"value,omitempty"`
}
StringConfig A simple string configuration. swagger:model StringConfig
func (*StringConfig) MarshalBinary ¶
func (m *StringConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StringConfig) UnmarshalBinary ¶
func (m *StringConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TextSetting ¶
type TextSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
// The maximum length the text can have.
MaxLength int64 `json:"maxLength,omitempty"`
// The minimum length the text can have.
MinLength int64 `json:"minLength,omitempty"`
// A string to be shown after the text input field.
// Max Length: 10
PostMessage string `json:"postMessage,omitempty"`
}
TextSetting Text Setting swagger:model TextSetting
func (*TextSetting) MarshalBinary ¶
func (m *TextSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (TextSetting) MarshalJSON ¶
func (m TextSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*TextSetting) UnmarshalBinary ¶
func (m *TextSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*TextSetting) UnmarshalJSON ¶
func (m *TextSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type TimeSetting ¶
type TimeSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
}
TimeSetting Time Setting swagger:model TimeSetting
func (*TimeSetting) MarshalBinary ¶
func (m *TimeSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (TimeSetting) MarshalJSON ¶
func (m TimeSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*TimeSetting) UnmarshalBinary ¶
func (m *TimeSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*TimeSetting) UnmarshalJSON ¶
func (m *TimeSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type TimerEvent ¶
type TimerEvent struct {
// The ID of the event.
EventID string `json:"eventId,omitempty"`
// The CRON expression if the schedule was of type CRON.
Expression string `json:"expression,omitempty"`
// The name of the schedule that caused this event.
Name string `json:"name,omitempty"`
// The IS0-8601 date time strings in UTC that this event was scheduled for.
Time string `json:"time,omitempty"`
// type
Type TimerType `json:"type,omitempty"`
}
TimerEvent An event that is caused by a schedule for this app being fired. swagger:model TimerEvent
func (*TimerEvent) MarshalBinary ¶
func (m *TimerEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TimerEvent) UnmarshalBinary ¶
func (m *TimerEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UninstallData ¶
type UninstallData struct {
// installed app
// Required: true
InstalledApp *InstalledApp `json:"installedApp"`
}
UninstallData The data payload to an execution request with an AppLifecycle of UNINSTALL. swagger:model UninstallData
func (*UninstallData) MarshalBinary ¶
func (m *UninstallData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UninstallData) UnmarshalBinary ¶
func (m *UninstallData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UninstallResponseData ¶
type UninstallResponseData interface{}
UninstallResponseData Empty object response for an Uninstall lifecycle execution.
swagger:model UninstallResponseData
type UpdateData ¶
type UpdateData struct {
// An OAuth token to use when calling into SmartThings API's.
// Required: true
AuthToken *string `json:"authToken"`
// installed app
// Required: true
InstalledApp *InstalledApp `json:"installedApp"`
// previous config
// Required: true
PreviousConfig ConfigMap `json:"previousConfig"`
// previous permissions
// Required: true
PreviousPermissions Permissions `json:"previousPermissions"`
// A refresh token which maybe used to obtain authorization to SmartThings API after expiration of the authToken.
// An integration will need to use this refreshToken to support calling the SmartThings API outside the context
// of an event.
//
RefreshToken string `json:"refreshToken,omitempty"`
}
UpdateData The data payload to an execution request with an AppLifecycle of UPDATE. swagger:model UpdateData
func (*UpdateData) MarshalBinary ¶
func (m *UpdateData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateData) UnmarshalBinary ¶
func (m *UpdateData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateResponseData ¶
type UpdateResponseData interface{}
UpdateResponseData Empty object response for an Update lifecycle execution.
swagger:model UpdateResponseData
type VideoSetting ¶
type VideoSetting struct {
SectionSetting
// The image url.
// Max Length: 2048
Image string `json:"image,omitempty"`
// The video url.
// Max Length: 2048
Video string `json:"video,omitempty"`
}
VideoSetting Video Setting swagger:model VideoSetting
func (*VideoSetting) MarshalBinary ¶
func (m *VideoSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (VideoSetting) MarshalJSON ¶
func (m VideoSetting) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*VideoSetting) UnmarshalBinary ¶
func (m *VideoSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*VideoSetting) UnmarshalJSON ¶
func (m *VideoSetting) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
Source Files
¶
- action.go
- action_type.go
- app_lifecycle.go
- basic_background_image.go
- basic_body.go
- basic_button.go
- basic_button_position.go
- basic_button_type.go
- basic_card.go
- basic_icon_button.go
- basic_image.go
- basic_image_position.go
- basic_text.go
- basic_text_button.go
- boolean_setting.go
- client_details.go
- config_entries.go
- config_entry.go
- config_map.go
- configuration_data.go
- configuration_phase.go
- configuration_response_data.go
- dashboard_card.go
- dashboard_card_template.go
- dashboard_data.go
- dashboard_response_data.go
- decimal_setting.go
- device_commands_event.go
- device_commands_event_command.go
- device_config.go
- device_event.go
- device_health_event.go
- device_lifecycle.go
- device_lifecycle_create.go
- device_lifecycle_delete.go
- device_lifecycle_event.go
- device_lifecycle_move.go
- device_lifecycle_update.go
- device_setting.go
- email_setting.go
- enum_setting.go
- enum_style_type.go
- event.go
- event_data.go
- event_response_data.go
- event_type.go
- execute_action.go
- execution_request.go
- execution_response.go
- free_form_card.go
- grouped_option.go
- image_setting.go
- images_setting.go
- initialize_setting.go
- install_data.go
- install_response_data.go
- installed_app.go
- launch_plugin_action.go
- link_setting.go
- link_style_type.go
- mode_config.go
- mode_event.go
- mode_setting.go
- number_setting.go
- o_auth_callback_data.go
- o_auth_callback_response_data.go
- o_auth_setting.go
- option.go
- page.go
- page_setting.go
- paragraph_setting.go
- password_setting.go
- permissions.go
- phone_setting.go
- ping_data.go
- ping_response_data.go
- scene_config.go
- scene_lifecycle.go
- scene_lifecycle_create.go
- scene_lifecycle_delete.go
- scene_lifecycle_event.go
- scene_lifecycle_update.go
- scene_setting.go
- section.go
- section_setting.go
- security_arm_state_event.go
- setting.go
- setting_type.go
- simple_value.go
- string_config.go
- style_type.go
- text_setting.go
- time_setting.go
- timer_event.go
- timer_type.go
- uninstall_data.go
- uninstall_response_data.go
- update_data.go
- update_response_data.go
- video_setting.go