Documentation
¶
Index ¶
- Constants
- type App
- type AppDeviceDetails
- type AppOAuth
- type AppType
- type Argument
- type AttributeState
- type Capability
- type CapabilityAttribute
- type CapabilityCommand
- type CapabilityDataType
- type CapabilityReference
- type CapabilityStatus
- type CapabilitySubscriptionDetail
- type CapabilitySummary
- type ChangeModeRequest
- type ComponentStatus
- type ComponentTranslations
- type ConfigEntries
- type ConfigEntry
- type ConfigMap
- type CreateAppRequest
- type CreateAppResponse
- type CreateDeviceCommandsResponse
- type CreateDeviceEventsResponse
- type CreateDeviceProfileRequest
- type CreateInstalledAppEventsRequest
- type CreateInstalledAppEventsResponse
- type CreateLocationRequest
- type CreateOrUpdateAppRequest
- type CreateOrUpdateLambdaSmartAppRequest
- type CreateOrUpdateWebhookSmartAppRequest
- type CronSchedule
- type DashboardCardLifecycle
- type DeleteAppResponse
- type DeleteDeviceCommandsResponse
- type DeleteDeviceProfileResponse
- type DeleteInstalledAppResponse
- type DeleteLocationResponse
- type DeleteScheduleResponse
- type Device
- type DeviceCommand
- type DeviceCommandsRequest
- type DeviceComponent
- type DeviceComponentReference
- type DeviceConfig
- type DeviceEventsRequest
- type DeviceHealthDetail
- type DeviceInstallRequest
- type DeviceInstallRequestApp
- type DeviceIntegrationType
- type DeviceLifecycleDetail
- type DeviceProfile
- type DeviceProfileLocaleTranslations
- type DeviceProfileMetadata
- type DeviceProfileReference
- type DeviceProfileStatus
- type DeviceProfileTranslations
- type DeviceStateEvent
- type DeviceStatus
- type DeviceSubscriptionDetail
- type DthDeviceDetails
- type Error
- type ErrorResponse
- type GenerateAppOAuthRequest
- type GenerateAppOAuthResponse
- type GetAppSettingsResponse
- type GetTagsResponse
- type HubHealthDetail
- type IconImage
- type InstallConfiguration
- type InstallConfigurationDetail
- type InstallConfigurationStatus
- type InstalledApp
- type InstalledAppStatus
- type InstalledAppType
- type LambdaSmartApp
- type Link
- type Links
- type LocaleReference
- type LocaleTag
- type Location
- type Mode
- type ModeConfig
- type ModeSubscriptionDetail
- type ModesResponse
- type OnceSchedule
- type Owner
- type PagedApp
- type PagedApps
- type PagedCapabilities
- type PagedDeviceProfiles
- type PagedDevices
- type PagedInstallConfigurations
- type PagedInstalledApps
- type PagedLocation
- type PagedLocations
- type PagedSchedules
- type PagedSubscriptions
- type PatchTagsRequest
- type PatchTagsResponse
- type PermissionConfig
- type SceneAction
- type SceneActionSequence
- type SceneArgument
- type SceneCapability
- type SceneCommand
- type SceneComponent
- type SceneConfig
- type SceneDevice
- type SceneDeviceRequest
- type SceneLifecycleDetail
- type SceneMode
- type SceneModeRequest
- type ScenePagedResult
- type SceneRequest
- type SceneSleepRequest
- type SceneSummary
- type Schedule
- type ScheduleRequest
- type SecurityArmStateDetail
- type SmartAppDashboardCardEventRequest
- type SmartAppEventRequest
- type StandardSuccessResponse
- type StringConfig
- type Subscription
- type SubscriptionDelete
- type SubscriptionRequest
- type SubscriptionSource
- type Tags
- type UpdateAppOAuthRequest
- type UpdateAppRequest
- type UpdateAppSettingsRequest
- type UpdateAppSettingsResponse
- type UpdateDeviceProfileRequest
- type UpdateDeviceRequest
- type UpdateLocationRequest
- type UpdateModeRequest
- type UpdateTagsRequest
- type UpdateTagsResponse
- type WebhookSmartApp
Constants ¶
const ( // CapabilityStatusProposed captures enum value "proposed" CapabilityStatusProposed string = "proposed" // CapabilityStatusLive captures enum value "live" CapabilityStatusLive string = "live" // CapabilityStatusDeprecated captures enum value "deprecated" CapabilityStatusDeprecated string = "deprecated" // CapabilityStatusDead captures enum value "dead" CapabilityStatusDead string = "dead" )
const ( // CapabilitySummaryStatusProposed captures enum value "proposed" CapabilitySummaryStatusProposed string = "proposed" // CapabilitySummaryStatusLive captures enum value "live" CapabilitySummaryStatusLive string = "live" // CapabilitySummaryStatusDeprecated captures enum value "deprecated" CapabilitySummaryStatusDeprecated string = "deprecated" // CapabilitySummaryStatusDead captures enum value "dead" CapabilitySummaryStatusDead string = "dead" )
const ( // ConfigEntryValueTypeSTRING captures enum value "STRING" ConfigEntryValueTypeSTRING string = "STRING" // ConfigEntryValueTypeDEVICE captures enum value "DEVICE" ConfigEntryValueTypeDEVICE string = "DEVICE" // ConfigEntryValueTypePERMISSION captures enum value "PERMISSION" ConfigEntryValueTypePERMISSION string = "PERMISSION" )
const ( // CreateLocationRequestTemperatureScaleF captures enum value "F" CreateLocationRequestTemperatureScaleF string = "F" // CreateLocationRequestTemperatureScaleC captures enum value "C" CreateLocationRequestTemperatureScaleC string = "C" )
const ( // LocationTemperatureScaleF captures enum value "F" LocationTemperatureScaleF string = "F" // LocationTemperatureScaleC captures enum value "C" LocationTemperatureScaleC string = "C" )
const ( // SceneCapabilityStatusProposed captures enum value "proposed" SceneCapabilityStatusProposed string = "proposed" // SceneCapabilityStatusLive captures enum value "live" SceneCapabilityStatusLive string = "live" // SceneCapabilityStatusDeprecated captures enum value "deprecated" SceneCapabilityStatusDeprecated string = "deprecated" // SceneCapabilityStatusDead captures enum value "dead" SceneCapabilityStatusDead string = "dead" )
const ( // UpdateLocationRequestTemperatureScaleF captures enum value "F" UpdateLocationRequestTemperatureScaleF string = "F" // UpdateLocationRequestTemperatureScaleC captures enum value "C" UpdateLocationRequestTemperatureScaleC string = "C" )
const ( // OwnerOwnerTypeUSER captures enum value "USER" OwnerOwnerTypeUSER string = "USER" )
const ( // StandardSuccessResponseStatusSuccess captures enum value "success" StandardSuccessResponseStatusSuccess string = "success" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App struct {
// A globally unique identifier for an app.
// Format: uuid
AppID strfmt.UUID `json:"appId,omitempty"`
// 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.
//
AppName string `json:"appName,omitempty"`
// app type
AppType AppType `json:"appType,omitempty"`
// A UTC ISO-8601 Date-Time String
// Format: date-time
CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`
// A default description for an app.
//
// Max Length: 250
Description string `json:"description,omitempty"`
// A default display name for an app.
//
// Max Length: 75
DisplayName string `json:"displayName,omitempty"`
// lambda smart app
LambdaSmartApp *LambdaSmartApp `json:"lambdaSmartApp,omitempty"`
// A UTC ISO-8601 Date-Time String
// Format: date-time
LastUpdatedDate strfmt.DateTime `json:"lastUpdatedDate,omitempty"`
// owner
Owner *Owner `json:"owner,omitempty"`
// Inform the installation systems that a particular app can only be installed once within a user's account.
//
SingleInstance *bool `json:"singleInstance,omitempty"`
// webhook smart app
WebhookSmartApp *WebhookSmartApp `json:"webhookSmartApp,omitempty"`
}
App app swagger:model App
func (*App) MarshalBinary ¶
MarshalBinary interface implementation
func (*App) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AppDeviceDetails ¶
type AppDeviceDetails struct {
// A field to store an ID from a system external to SmartThings.
// Max Length: 64
ExternalID string `json:"externalId,omitempty"`
// The ID of the installed app that integrates this device.
InstalledAppID string `json:"installedAppId,omitempty"`
// profile
Profile *DeviceProfileReference `json:"profile,omitempty"`
}
AppDeviceDetails app device details swagger:model AppDeviceDetails
func (*AppDeviceDetails) MarshalBinary ¶
func (m *AppDeviceDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppDeviceDetails) UnmarshalBinary ¶
func (m *AppDeviceDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppOAuth ¶
type AppOAuth struct {
// A name given to the OAuth Client.
ClientName string `json:"clientName,omitempty"`
// A list of SmartThings API OAuth scope identifiers that maybe required to execute your integration.
Scope []string `json:"scope"`
}
AppOAuth app o auth swagger:model AppOAuth
func (*AppOAuth) MarshalBinary ¶
MarshalBinary interface implementation
func (*AppOAuth) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Argument ¶
type Argument struct {
// A name that is unique within the command. Used for i18n and named argument command execution.
// Pattern: ^[a-zA-Z0-9 ]*$
Name string `json:"name,omitempty"`
// 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 bool `json:"optional,omitempty"`
// [JSON schema](http://json-schema.org/specification-links.html#draft-4) for the argument.
//
Schema interface{} `json:"schema,omitempty"`
}
Argument argument swagger:model Argument
func (*Argument) MarshalBinary ¶
MarshalBinary interface implementation
func (*Argument) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AttributeState ¶
type AttributeState struct {
// unit
Unit string `json:"unit,omitempty"`
// value
Value interface{} `json:"value,omitempty"`
}
AttributeState attribute state swagger:model AttributeState
func (*AttributeState) MarshalBinary ¶
func (m *AttributeState) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AttributeState) UnmarshalBinary ¶
func (m *AttributeState) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Capability ¶
type Capability struct {
// A mapping of attribute names to their definitions. All attribute names are lower camelcase.
Attributes map[string]CapabilityAttribute `json:"attributes,omitempty"`
// A mapping of command names to their definitions. All command names are lower camelcase.
Commands map[string]CapabilityCommand `json:"commands,omitempty"`
// A URL safe unique identifier for the capability.
ID string `json:"id,omitempty"`
// An English language name for the capability. This can contain spaces and special characters
Name string `json:"name,omitempty"`
// 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.
//
// Enum: [proposed live deprecated dead]
Status string `json:"status,omitempty"`
// The version number of the capability.
Version *int64 `json:"version,omitempty"`
}
Capability capability swagger:model Capability
func (*Capability) MarshalBinary ¶
func (m *Capability) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Capability) UnmarshalBinary ¶
func (m *Capability) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CapabilityAttribute ¶
type CapabilityAttribute struct {
// [JSON schema](http://json-schema.org/specification-links.html#draft-4) for the attribute.
//
Schema interface{} `json:"schema,omitempty"`
}
CapabilityAttribute capability attribute swagger:model CapabilityAttribute
func (*CapabilityAttribute) MarshalBinary ¶
func (m *CapabilityAttribute) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CapabilityAttribute) UnmarshalBinary ¶
func (m *CapabilityAttribute) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CapabilityCommand ¶
type CapabilityCommand struct {
// An array of argument definitions. THe arguments must be supplied in the order specified.
Arguments []*Argument `json:"arguments"`
// The name of the command. Unique for the capability
Name string `json:"name,omitempty"`
}
CapabilityCommand capability command swagger:model CapabilityCommand
func (*CapabilityCommand) MarshalBinary ¶
func (m *CapabilityCommand) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CapabilityCommand) UnmarshalBinary ¶
func (m *CapabilityCommand) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CapabilityDataType ¶
type CapabilityDataType string
CapabilityDataType __DEPRECATED__ only available while migrating from `type` to `schema` swagger:model CapabilityDataType
const ( // CapabilityDataTypeSTRING captures enum value "STRING" CapabilityDataTypeSTRING CapabilityDataType = "STRING" // CapabilityDataTypeNUMBER captures enum value "NUMBER" CapabilityDataTypeNUMBER CapabilityDataType = "NUMBER" // CapabilityDataTypeENUM captures enum value "ENUM" CapabilityDataTypeENUM CapabilityDataType = "ENUM" // CapabilityDataTypeJSONOBJECT captures enum value "JSON_OBJECT" CapabilityDataTypeJSONOBJECT CapabilityDataType = "JSON_OBJECT" // CapabilityDataTypeDATE captures enum value "DATE" CapabilityDataTypeDATE CapabilityDataType = "DATE" // CapabilityDataTypeVECTOR3 captures enum value "VECTOR3" CapabilityDataTypeVECTOR3 CapabilityDataType = "VECTOR3" // CapabilityDataTypeDYNAMICENUM captures enum value "DYNAMIC_ENUM" CapabilityDataTypeDYNAMICENUM CapabilityDataType = "DYNAMIC_ENUM" // CapabilityDataTypeCOLORMAP captures enum value "COLOR_MAP" CapabilityDataTypeCOLORMAP CapabilityDataType = "COLOR_MAP" // CapabilityDataTypeBOOLEAN captures enum value "BOOLEAN" CapabilityDataTypeBOOLEAN CapabilityDataType = "BOOLEAN" )
type CapabilityReference ¶
type CapabilityReference struct {
// id
// Required: true
ID *string `json:"id"`
}
CapabilityReference capability reference swagger:model CapabilityReference
func (*CapabilityReference) MarshalBinary ¶
func (m *CapabilityReference) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CapabilityReference) UnmarshalBinary ¶
func (m *CapabilityReference) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CapabilityStatus ¶
type CapabilityStatus map[string]AttributeState
CapabilityStatus A map of Attribute name to Attribute state. swagger:model CapabilityStatus
type CapabilitySubscriptionDetail ¶
type CapabilitySubscriptionDetail struct {
// Name of the capabilities attribute or * for all.
// Max Length: 256
// Min Length: 1
Attribute string `json:"attribute,omitempty"`
// Name of the capability that is subscribed to.
// Required: true
// Max Length: 128
// Min Length: 1
Capability *string `json:"capability"`
// The id of the location that both the app and source device are in.
// Required: true
LocationID *string `json:"locationId"`
// Only execute the subscription if the subscribed event is a state change from previous events.
StateChangeOnly *bool `json:"stateChangeOnly,omitempty"`
// A name for the subscription that will be passed to the installed app. Must be unique per installed app.
SubscriptionName string `json:"subscriptionName,omitempty"`
// A particular value for the attribute that will trigger the subscription or * for all.
// Max Length: 256
Value interface{} `json:"value,omitempty"`
}
CapabilitySubscriptionDetail Details of a subscription of source type CAPABILITY. The combination of subscribed values must be unique per installed app. swagger:model CapabilitySubscriptionDetail
func (*CapabilitySubscriptionDetail) MarshalBinary ¶
func (m *CapabilitySubscriptionDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CapabilitySubscriptionDetail) UnmarshalBinary ¶
func (m *CapabilitySubscriptionDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CapabilitySummary ¶
type CapabilitySummary struct {
// A URL safe unique identifier for the capability.
ID string `json:"id,omitempty"`
// 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.
//
// Enum: [proposed live deprecated dead]
Status string `json:"status,omitempty"`
// The version number of the capability.
Version *int64 `json:"version,omitempty"`
}
CapabilitySummary capability summary swagger:model CapabilitySummary
func (*CapabilitySummary) MarshalBinary ¶
func (m *CapabilitySummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CapabilitySummary) UnmarshalBinary ¶
func (m *CapabilitySummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ChangeModeRequest ¶
type ChangeModeRequest struct {
// Update the current mode for this location to the given mode ID.
// Required: true
ModeID *string `json:"modeId"`
}
ChangeModeRequest change mode request swagger:model ChangeModeRequest
func (*ChangeModeRequest) MarshalBinary ¶
func (m *ChangeModeRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ChangeModeRequest) UnmarshalBinary ¶
func (m *ChangeModeRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ComponentStatus ¶
type ComponentStatus map[string]CapabilityStatus
ComponentStatus A map of capabilityId to Capability status. swagger:model ComponentStatus
type ComponentTranslations ¶
type ComponentTranslations struct {
// UTF-8 text describing the component.
// Max Length: 255
Description string `json:"description,omitempty"`
// Short UTF-8 text used when displaying the component.
// Max Length: 25
Label string `json:"label,omitempty"`
}
ComponentTranslations A map of i18n translations. swagger:model ComponentTranslations
func (*ComponentTranslations) MarshalBinary ¶
func (m *ComponentTranslations) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ComponentTranslations) UnmarshalBinary ¶
func (m *ComponentTranslations) 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 PERMISSION, meaningless otherwise
PermissionConfig *PermissionConfig `json:"permissionConfig,omitempty"`
// The config if valueType is STRING, meaningless otherwise
StringConfig *StringConfig `json:"stringConfig,omitempty"`
// The value type.
// Enum: [STRING DEVICE PERMISSION]
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 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.
swagger:model ConfigMap
type CreateAppRequest ¶
type CreateAppRequest struct {
// 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.
//
// Required: true
AppName *string `json:"appName"`
// app type
// Required: true
AppType AppType `json:"appType"`
// A default description for an app.
//
// Required: true
// Max Length: 250
Description *string `json:"description"`
// A default display name for an app.
//
// Required: true
// Max Length: 75
DisplayName *string `json:"displayName"`
// icon image
IconImage *IconImage `json:"iconImage,omitempty"`
// lambda smart app
LambdaSmartApp *CreateOrUpdateLambdaSmartAppRequest `json:"lambdaSmartApp,omitempty"`
// oauth
Oauth *AppOAuth `json:"oauth,omitempty"`
// Inform the installation systems that a particular app can only be installed once within a user's account.
//
SingleInstance *bool `json:"singleInstance,omitempty"`
// webhook smart app
WebhookSmartApp *CreateOrUpdateWebhookSmartAppRequest `json:"webhookSmartApp,omitempty"`
}
CreateAppRequest create app request swagger:model CreateAppRequest
func (*CreateAppRequest) MarshalBinary ¶
func (m *CreateAppRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateAppRequest) UnmarshalBinary ¶
func (m *CreateAppRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateAppResponse ¶
type CreateAppResponse struct {
// app
App *App `json:"app,omitempty"`
// The OAuth Client ID.
// Format: uuid
OauthClientID strfmt.UUID `json:"oauthClientId,omitempty"`
// The OAuth Client Secret.
// Format: uuid
OauthClientSecret strfmt.UUID `json:"oauthClientSecret,omitempty"`
}
CreateAppResponse A response object containing the newly created App and OAuth client details. swagger:model CreateAppResponse
func (*CreateAppResponse) MarshalBinary ¶
func (m *CreateAppResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateAppResponse) UnmarshalBinary ¶
func (m *CreateAppResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateDeviceCommandsResponse ¶
type CreateDeviceCommandsResponse interface{}
CreateDeviceCommandsResponse create device commands response swagger:model CreateDeviceCommandsResponse
type CreateDeviceEventsResponse ¶
type CreateDeviceEventsResponse interface{}
CreateDeviceEventsResponse create device events response swagger:model CreateDeviceEventsResponse
type CreateDeviceProfileRequest ¶
type CreateDeviceProfileRequest struct {
// components
// Required: true
// Max Items: 10
// Min Items: 1
Components []*DeviceComponent `json:"components"`
// metadata
Metadata DeviceProfileMetadata `json:"metadata,omitempty"`
// The name of the device profile.
// Required: true
Name *string `json:"name"`
}
CreateDeviceProfileRequest create device profile request swagger:model CreateDeviceProfileRequest
func (*CreateDeviceProfileRequest) MarshalBinary ¶
func (m *CreateDeviceProfileRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateDeviceProfileRequest) UnmarshalBinary ¶
func (m *CreateDeviceProfileRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateInstalledAppEventsRequest ¶
type CreateInstalledAppEventsRequest struct {
// 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.
//
// Max Items: 8
// Min Items: 1
SmartAppDashboardCardEvents []*SmartAppDashboardCardEventRequest `json:"smartAppDashboardCardEvents"`
// 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.
//
// Max Items: 8
// Min Items: 1
SmartAppEvents []*SmartAppEventRequest `json:"smartAppEvents"`
}
CreateInstalledAppEventsRequest create installed app events request swagger:model CreateInstalledAppEventsRequest
func (*CreateInstalledAppEventsRequest) MarshalBinary ¶
func (m *CreateInstalledAppEventsRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateInstalledAppEventsRequest) UnmarshalBinary ¶
func (m *CreateInstalledAppEventsRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateInstalledAppEventsResponse ¶
type CreateInstalledAppEventsResponse interface{}
CreateInstalledAppEventsResponse create installed app events response swagger:model CreateInstalledAppEventsResponse
type CreateLocationRequest ¶
type CreateLocationRequest struct {
// An ISO Alpha-3 country code. (i.e. GBR, USA)
// Required: true
CountryCode *string `json:"countryCode"`
// A geographical latitude.
Latitude float32 `json:"latitude,omitempty"`
// An IETF BCP 47 language tag representing the chosen locale for this location.
Locale string `json:"locale,omitempty"`
// A geographical longitude.
Longitude float32 `json:"longitude,omitempty"`
// A nickname given for the location (eg. Home)
// Required: true
Name *string `json:"name"`
// The radius in meters around latitude and longitude which defines this location.
RegionRadius int64 `json:"regionRadius,omitempty"`
// The desired temperature scale used within location.
// Enum: [F C]
TemperatureScale string `json:"temperatureScale,omitempty"`
}
CreateLocationRequest create location request swagger:model CreateLocationRequest
func (*CreateLocationRequest) MarshalBinary ¶
func (m *CreateLocationRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateLocationRequest) UnmarshalBinary ¶
func (m *CreateLocationRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateOrUpdateAppRequest ¶
type CreateOrUpdateAppRequest struct {
// 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.
//
// Required: true
AppName *string `json:"appName"`
// app type
// Required: true
AppType AppType `json:"appType"`
// A default description for an app.
//
// Required: true
// Max Length: 250
Description *string `json:"description"`
// A default display name for an app.
//
// Required: true
// Max Length: 75
DisplayName *string `json:"displayName"`
// lambda smart app
LambdaSmartApp *CreateOrUpdateLambdaSmartAppRequest `json:"lambdaSmartApp,omitempty"`
// Inform the installation systems that a particular app can only be installed once within a user's account.
//
SingleInstance *bool `json:"singleInstance,omitempty"`
// webhook smart app
WebhookSmartApp *CreateOrUpdateWebhookSmartAppRequest `json:"webhookSmartApp,omitempty"`
}
CreateOrUpdateAppRequest create or update app request swagger:model CreateOrUpdateAppRequest
func (*CreateOrUpdateAppRequest) MarshalBinary ¶
func (m *CreateOrUpdateAppRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateOrUpdateAppRequest) UnmarshalBinary ¶
func (m *CreateOrUpdateAppRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateOrUpdateLambdaSmartAppRequest ¶
type CreateOrUpdateLambdaSmartAppRequest struct {
// A list of AWS arns referencing a Lambda function.
// Required: true
Functions []string `json:"functions"`
}
CreateOrUpdateLambdaSmartAppRequest Details related to a Lambda Smart App implementation. This model should only be specified for apps of type LAMBDA_SMART_APP.
swagger:model CreateOrUpdateLambdaSmartAppRequest
func (*CreateOrUpdateLambdaSmartAppRequest) MarshalBinary ¶
func (m *CreateOrUpdateLambdaSmartAppRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateOrUpdateLambdaSmartAppRequest) UnmarshalBinary ¶
func (m *CreateOrUpdateLambdaSmartAppRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateOrUpdateWebhookSmartAppRequest ¶
type CreateOrUpdateWebhookSmartAppRequest struct {
// A URL that should be invoked during execution.
TargetURL string `json:"targetUrl,omitempty"`
}
CreateOrUpdateWebhookSmartAppRequest Details related to a Webhook Smart App implementation. This model should only be specified for apps of type WEBHOOK_SMART_APP.
swagger:model CreateOrUpdateWebhookSmartAppRequest
func (*CreateOrUpdateWebhookSmartAppRequest) MarshalBinary ¶
func (m *CreateOrUpdateWebhookSmartAppRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateOrUpdateWebhookSmartAppRequest) UnmarshalBinary ¶
func (m *CreateOrUpdateWebhookSmartAppRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CronSchedule ¶
type CronSchedule struct {
// 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.
//
// Required: true
// Max Length: 256
Expression *string `json:"expression"`
// The timezone id for CRON schedules.
// Required: true
Timezone *string `json:"timezone"`
}
CronSchedule cron schedule swagger:model CronSchedule
func (*CronSchedule) MarshalBinary ¶
func (m *CronSchedule) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CronSchedule) UnmarshalBinary ¶
func (m *CronSchedule) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DashboardCardLifecycle ¶
type DashboardCardLifecycle string
DashboardCardLifecycle dashboard card lifecycle swagger:model DashboardCardLifecycle
const ( // DashboardCardLifecycleUPDATE captures enum value "UPDATE" DashboardCardLifecycleUPDATE DashboardCardLifecycle = "UPDATE" // DashboardCardLifecycleDELETE captures enum value "DELETE" DashboardCardLifecycleDELETE DashboardCardLifecycle = "DELETE" )
type DeleteAppResponse ¶
type DeleteAppResponse interface{}
DeleteAppResponse An empty object 200 response. swagger:model DeleteAppResponse
type DeleteDeviceCommandsResponse ¶
type DeleteDeviceCommandsResponse interface{}
DeleteDeviceCommandsResponse delete device commands response swagger:model DeleteDeviceCommandsResponse
type DeleteDeviceProfileResponse ¶
type DeleteDeviceProfileResponse interface{}
DeleteDeviceProfileResponse delete device profile response swagger:model DeleteDeviceProfileResponse
type DeleteInstalledAppResponse ¶
type DeleteInstalledAppResponse struct {
// count
Count int32 `json:"count,omitempty"`
}
DeleteInstalledAppResponse The number of deleted installed apps. swagger:model DeleteInstalledAppResponse
func (*DeleteInstalledAppResponse) MarshalBinary ¶
func (m *DeleteInstalledAppResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteInstalledAppResponse) UnmarshalBinary ¶
func (m *DeleteInstalledAppResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeleteLocationResponse ¶
type DeleteLocationResponse interface{}
DeleteLocationResponse An empty object response. swagger:model DeleteLocationResponse
type DeleteScheduleResponse ¶
type DeleteScheduleResponse interface{}
DeleteScheduleResponse Delete schedule response swagger:model DeleteScheduleResponse
type Device ¶
type Device struct {
// Device Profile information for the SmartApp. This field will be empty if device type is not ENDPOINT_APP.
App *AppDeviceDetails `json:"app,omitempty"`
// The IDs of all components on the device.
Components []*DeviceComponent `json:"components"`
// The identifier for the device instance.
DeviceID string `json:"deviceId,omitempty"`
// The device manufacturer code.
DeviceManufacturerCode string `json:"deviceManufacturerCode,omitempty"`
// Deprecated please look under "dth".
DeviceNetworkType string `json:"deviceNetworkType,omitempty"`
// Deprecated please look under "dth".
DeviceTypeID string `json:"deviceTypeId,omitempty"`
// Deprecated please look under "dth".
DeviceTypeName string `json:"deviceTypeName,omitempty"`
// Device Profile information for DTH. This field will be empty if device type is not DTH.
Dth *DthDeviceDetails `json:"dth,omitempty"`
// The name that a user chooses for the device. This defaults to the same value as name.
Label string `json:"label,omitempty"`
// The ID of the Location with which the device is associated.
LocationID string `json:"locationId,omitempty"`
// The name that the device integration (Device Handler or SmartApp) defines for the device.
Name string `json:"name,omitempty"`
// type
Type DeviceIntegrationType `json:"type,omitempty"`
}
Device device swagger:model Device
func (*Device) MarshalBinary ¶
MarshalBinary interface implementation
func (*Device) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type DeviceCommand ¶
type DeviceCommand struct {
// Arguments of the command.
// The type of the arguments are dependent on the type of the capability's command argument
//
Arguments []interface{} `json:"arguments"`
// Capability that this command relates to. This must be a capability of the component.
// Required: true
Capability *string `json:"capability"`
// Name of the command, this must be valid for the capability.
// Required: true
Command *string `json:"command"`
// The name of the component on this device, default is 'main'. The component must be valid for the device.
Component *string `json:"component,omitempty"`
}
DeviceCommand device command swagger:model DeviceCommand
func (*DeviceCommand) MarshalBinary ¶
func (m *DeviceCommand) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceCommand) UnmarshalBinary ¶
func (m *DeviceCommand) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceCommandsRequest ¶
type DeviceCommandsRequest struct {
// An array of commands to execute on the Device.
Commands []*DeviceCommand `json:"commands"`
}
DeviceCommandsRequest device commands request swagger:model DeviceCommandsRequest
func (*DeviceCommandsRequest) MarshalBinary ¶
func (m *DeviceCommandsRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceCommandsRequest) UnmarshalBinary ¶
func (m *DeviceCommandsRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceComponent ¶
type DeviceComponent struct {
// capabilities
// Required: true
// Max Items: 20
// Min Items: 1
Capabilities []*CapabilityReference `json:"capabilities"`
// id
// Required: true
ID *string `json:"id"`
}
DeviceComponent device component swagger:model DeviceComponent
func (*DeviceComponent) MarshalBinary ¶
func (m *DeviceComponent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceComponent) UnmarshalBinary ¶
func (m *DeviceComponent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceComponentReference ¶
type DeviceComponentReference struct {
// A list of `[ 1..20 ]` capabilities for this component.
// Required: true
// Max Items: 20
// Min Items: 1
Capabilities []*CapabilityReference `json:"capabilities"`
// id
// Required: true
ID *string `json:"id"`
}
DeviceComponentReference device component reference swagger:model DeviceComponentReference
func (*DeviceComponentReference) MarshalBinary ¶
func (m *DeviceComponentReference) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceComponentReference) UnmarshalBinary ¶
func (m *DeviceComponentReference) 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"`
// permissions
// Max Items: 25
Permissions []string `json:"permissions"`
}
DeviceConfig A device and component configuration with any required permissions. 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 DeviceEventsRequest ¶
type DeviceEventsRequest struct {
// An array of attribute state updates.
// Max Items: 8
// Min Items: 1
DeviceEvents []*DeviceStateEvent `json:"deviceEvents"`
}
DeviceEventsRequest device events request swagger:model DeviceEventsRequest
func (*DeviceEventsRequest) MarshalBinary ¶
func (m *DeviceEventsRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceEventsRequest) UnmarshalBinary ¶
func (m *DeviceEventsRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceHealthDetail ¶
type DeviceHealthDetail struct {
// An array of GUIDs of devices being subscribed to. A max of 20 GUIDs are allowed.
// Max Items: 20
DeviceIds []string `json:"deviceIds"`
// The id of the location that both the app and source device are in.
LocationID string `json:"locationId,omitempty"`
// A name for the subscription that will be passed to the installed app.
SubscriptionName string `json:"subscriptionName,omitempty"`
}
DeviceHealthDetail Details of a subscription of source type DEVICE_HEALTH. Only one of deviceIds or locationId should be supplied. swagger:model DeviceHealthDetail
func (*DeviceHealthDetail) MarshalBinary ¶
func (m *DeviceHealthDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceHealthDetail) UnmarshalBinary ¶
func (m *DeviceHealthDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceInstallRequest ¶
type DeviceInstallRequest struct {
// app
// Required: true
App *DeviceInstallRequestApp `json:"app"`
// The label for the device.
Label string `json:"label,omitempty"`
// The ID of the Location with which the device is associated.
// Required: true
LocationID *string `json:"locationId"`
}
DeviceInstallRequest device install request swagger:model DeviceInstallRequest
func (*DeviceInstallRequest) MarshalBinary ¶
func (m *DeviceInstallRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceInstallRequest) UnmarshalBinary ¶
func (m *DeviceInstallRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceInstallRequestApp ¶
type DeviceInstallRequestApp struct {
// A field to store an ID from a system external to SmartThings.
// Max Length: 64
ExternalID string `json:"externalId,omitempty"`
// The ID of the installed application
// Required: true
InstalledAppID *string `json:"installedAppId"`
// The device profile Id
// Required: true
ProfileID *string `json:"profileId"`
}
DeviceInstallRequestApp device install request app swagger:model DeviceInstallRequestApp
func (*DeviceInstallRequestApp) MarshalBinary ¶
func (m *DeviceInstallRequestApp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceInstallRequestApp) UnmarshalBinary ¶
func (m *DeviceInstallRequestApp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceIntegrationType ¶
type DeviceIntegrationType string
DeviceIntegrationType The type of device integration. 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.
swagger:model DeviceIntegrationType
const ( // DeviceIntegrationTypeDTH captures enum value "DTH" DeviceIntegrationTypeDTH DeviceIntegrationType = "DTH" // DeviceIntegrationTypeENDPOINTAPP captures enum value "ENDPOINT_APP" DeviceIntegrationTypeENDPOINTAPP DeviceIntegrationType = "ENDPOINT_APP" )
type DeviceLifecycleDetail ¶
type DeviceLifecycleDetail struct {
// An array of GUIDs of devices being subscribed to. A max of 20 GUIDs are allowed.
// Max Items: 20
DeviceIds []string `json:"deviceIds"`
// The id of the location that both the app and source device are in.
LocationID string `json:"locationId,omitempty"`
// A name for the subscription that will be passed to the installed app.
SubscriptionName string `json:"subscriptionName,omitempty"`
}
DeviceLifecycleDetail Details of a subscription of source type DEVICE_LIFECYCLE. Only one of deviceIds or locationId should be supplied. swagger:model DeviceLifecycleDetail
func (*DeviceLifecycleDetail) MarshalBinary ¶
func (m *DeviceLifecycleDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceLifecycleDetail) UnmarshalBinary ¶
func (m *DeviceLifecycleDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceProfile ¶
type DeviceProfile struct {
// components
Components []*DeviceComponent `json:"components"`
// id
ID string `json:"id,omitempty"`
// metadata
Metadata DeviceProfileMetadata `json:"metadata,omitempty"`
// name
Name string `json:"name,omitempty"`
// owner
Owner *Owner `json:"owner,omitempty"`
}
DeviceProfile device profile swagger:model DeviceProfile
func (*DeviceProfile) MarshalBinary ¶
func (m *DeviceProfile) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceProfile) UnmarshalBinary ¶
func (m *DeviceProfile) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceProfileLocaleTranslations ¶
type DeviceProfileLocaleTranslations struct {
// items
Items []*LocaleReference `json:"items"`
}
DeviceProfileLocaleTranslations The list of supported locales for the device profile. swagger:model DeviceProfileLocaleTranslations
func (*DeviceProfileLocaleTranslations) MarshalBinary ¶
func (m *DeviceProfileLocaleTranslations) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceProfileLocaleTranslations) UnmarshalBinary ¶
func (m *DeviceProfileLocaleTranslations) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceProfileMetadata ¶
DeviceProfileMetadata Additional information about the device profile. swagger:model DeviceProfileMetadata
type DeviceProfileReference ¶
type DeviceProfileReference struct {
// The device profile Id
ID string `json:"id,omitempty"`
}
DeviceProfileReference device profile reference swagger:model DeviceProfileReference
func (*DeviceProfileReference) MarshalBinary ¶
func (m *DeviceProfileReference) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceProfileReference) UnmarshalBinary ¶
func (m *DeviceProfileReference) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceProfileStatus ¶
type DeviceProfileStatus string
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.
swagger:model DeviceProfileStatus
const ( // DeviceProfileStatusDEVELOPMENT captures enum value "DEVELOPMENT" DeviceProfileStatusDEVELOPMENT DeviceProfileStatus = "DEVELOPMENT" // DeviceProfileStatusPUBLISHED captures enum value "PUBLISHED" DeviceProfileStatusPUBLISHED DeviceProfileStatus = "PUBLISHED" )
type DeviceProfileTranslations ¶
type DeviceProfileTranslations struct {
// A map of component ID to it's translations.
Components map[string]ComponentTranslations `json:"components,omitempty"`
// tag
Tag LocaleTag `json:"tag,omitempty"`
}
DeviceProfileTranslations device profile translations swagger:model DeviceProfileTranslations
func (*DeviceProfileTranslations) MarshalBinary ¶
func (m *DeviceProfileTranslations) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceProfileTranslations) UnmarshalBinary ¶
func (m *DeviceProfileTranslations) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceStateEvent ¶
type DeviceStateEvent struct {
// Name of the capability attribute that this event relates to.
Attribute string `json:"attribute,omitempty"`
// Capability that this event relates to.
Capability string `json:"capability,omitempty"`
// The name of the component on this device, default is 'main'.
Component string `json:"component,omitempty"`
// Unit of the value field.
Unit string `json:"unit,omitempty"`
// Value associated with the event. The valid value depends on the capability.
Value interface{} `json:"value,omitempty"`
}
DeviceStateEvent device state event swagger:model DeviceStateEvent
func (*DeviceStateEvent) MarshalBinary ¶
func (m *DeviceStateEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceStateEvent) UnmarshalBinary ¶
func (m *DeviceStateEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceStatus ¶
type DeviceStatus struct {
// A map of componentId to Component status.
Components map[string]ComponentStatus `json:"components,omitempty"`
}
DeviceStatus The status of a Device. swagger:model DeviceStatus
func (*DeviceStatus) MarshalBinary ¶
func (m *DeviceStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceStatus) UnmarshalBinary ¶
func (m *DeviceStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceSubscriptionDetail ¶
type DeviceSubscriptionDetail struct {
// Name of the capabilities attribute or * for all.
// Max Length: 256
// Min Length: 1
Attribute string `json:"attribute,omitempty"`
// Name of the capability that is subscribed to or * for all.
// Max Length: 128
// Min Length: 1
Capability string `json:"capability,omitempty"`
// The component ID on the device that is subscribed to or * for all.
ComponentID *string `json:"componentId,omitempty"`
// The GUID of the device that is subscribed to.
// Required: true
DeviceID *string `json:"deviceId"`
// Only execute the subscription if the subscribed event is a state change from previous events.
StateChangeOnly bool `json:"stateChangeOnly,omitempty"`
// A name for the subscription that will be passed to the installed app. Must be unique per installed app.
SubscriptionName string `json:"subscriptionName,omitempty"`
// A particular value for the attribute that will trigger the subscription or * for all.
// Max Length: 256
Value interface{} `json:"value,omitempty"`
}
DeviceSubscriptionDetail Details of a subscription of source type DEVICE. The combination of subscribed values must be unique per installed app. swagger:model DeviceSubscriptionDetail
func (*DeviceSubscriptionDetail) MarshalBinary ¶
func (m *DeviceSubscriptionDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceSubscriptionDetail) UnmarshalBinary ¶
func (m *DeviceSubscriptionDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DthDeviceDetails ¶
type DthDeviceDetails struct {
// The device network type.
DeviceNetworkType string `json:"deviceNetworkType,omitempty"`
// The identifier for the device's DeviceType.
DeviceTypeID string `json:"deviceTypeId,omitempty"`
// The name for the device's DeviceType.
DeviceTypeName string `json:"deviceTypeName,omitempty"`
}
DthDeviceDetails dth device details swagger:model DthDeviceDetails
func (*DthDeviceDetails) MarshalBinary ¶
func (m *DthDeviceDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DthDeviceDetails) UnmarshalBinary ¶
func (m *DthDeviceDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// Machine readable error code.
Code string `json:"code,omitempty"`
// details
Details []*Error `json:"details"`
// Human readable error message.
Message string `json:"message,omitempty"`
// Optional field used to point to a problamatic part of the request.
Target string `json:"target,omitempty"`
}
Error Details about the error. swagger:model Error
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ErrorResponse ¶
type ErrorResponse struct {
// error
Error *Error `json:"error,omitempty"`
// A correlation id used for reference when contacting support.
RequestID string `json:"requestId,omitempty"`
}
ErrorResponse error response swagger:model ErrorResponse
func (*ErrorResponse) MarshalBinary ¶
func (m *ErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorResponse) UnmarshalBinary ¶
func (m *ErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GenerateAppOAuthRequest ¶
type GenerateAppOAuthRequest struct {
// A name given to the OAuth Client.
ClientName string `json:"clientName,omitempty"`
// A list of SmartThings API OAuth scope identifiers that maybe required to execute your integration.
Scope []string `json:"scope"`
}
GenerateAppOAuthRequest generate app o auth request swagger:model GenerateAppOAuthRequest
func (*GenerateAppOAuthRequest) MarshalBinary ¶
func (m *GenerateAppOAuthRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GenerateAppOAuthRequest) UnmarshalBinary ¶
func (m *GenerateAppOAuthRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GenerateAppOAuthResponse ¶
type GenerateAppOAuthResponse struct {
// oauth client details
OauthClientDetails *AppOAuth `json:"oauthClientDetails,omitempty"`
// The OAuth Client ID.
// Format: uuid
OauthClientID strfmt.UUID `json:"oauthClientId,omitempty"`
// The OAuth Client Secret.
// Format: uuid
OauthClientSecret strfmt.UUID `json:"oauthClientSecret,omitempty"`
}
GenerateAppOAuthResponse A response object containing a new OAuth Client and it's details. swagger:model GenerateAppOAuthResponse
func (*GenerateAppOAuthResponse) MarshalBinary ¶
func (m *GenerateAppOAuthResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GenerateAppOAuthResponse) UnmarshalBinary ¶
func (m *GenerateAppOAuthResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetAppSettingsResponse ¶
type GetAppSettingsResponse struct {
// settings
Settings map[string]string `json:"settings,omitempty"`
}
GetAppSettingsResponse Settings for a given app swagger:model GetAppSettingsResponse
func (*GetAppSettingsResponse) MarshalBinary ¶
func (m *GetAppSettingsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetAppSettingsResponse) UnmarshalBinary ¶
func (m *GetAppSettingsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetTagsResponse ¶
type GetTagsResponse struct {
// tags
Tags Tags `json:"tags,omitempty"`
}
GetTagsResponse A response object containing the resource's tags. swagger:model GetTagsResponse
func (*GetTagsResponse) MarshalBinary ¶
func (m *GetTagsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetTagsResponse) UnmarshalBinary ¶
func (m *GetTagsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HubHealthDetail ¶
type HubHealthDetail struct {
// The id of the location that both the app and hubs are in
// Required: true
LocationID *string `json:"locationId"`
// A name for the subscription that will be passed to the installed app.
SubscriptionName string `json:"subscriptionName,omitempty"`
}
HubHealthDetail Details of a subscription of souce type HUB_HEALTH swagger:model HubHealthDetail
func (*HubHealthDetail) MarshalBinary ¶
func (m *HubHealthDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HubHealthDetail) UnmarshalBinary ¶
func (m *HubHealthDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IconImage ¶
type IconImage struct {
// A default icon image url for an app. https url required.
//
// Format: uri
URL strfmt.URI `json:"url,omitempty"`
}
IconImage A default icon image for the app. swagger:model IconImage
func (*IconImage) MarshalBinary ¶
MarshalBinary interface implementation
func (*IconImage) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type InstallConfiguration ¶
type InstallConfiguration struct {
// The ID to this configuration instance.
// Format: uuid
ConfigurationID strfmt.UUID `json:"configurationId,omitempty"`
// configuration status
ConfigurationStatus InstallConfigurationStatus `json:"configurationStatus,omitempty"`
// A UTC ISO-8601 Date-Time String
// Format: date-time
CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`
// The ID of the installed app.
// Format: uuid
InstalledAppID strfmt.UUID `json:"installedAppId,omitempty"`
// A UTC ISO-8601 Date-Time String
// Format: date-time
LastUpdatedDate strfmt.DateTime `json:"lastUpdatedDate,omitempty"`
}
InstallConfiguration An configuration instance of an Installed App. swagger:model InstallConfiguration
func (*InstallConfiguration) MarshalBinary ¶
func (m *InstallConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InstallConfiguration) UnmarshalBinary ¶
func (m *InstallConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InstallConfigurationDetail ¶
type InstallConfigurationDetail struct {
// config
Config ConfigMap `json:"config,omitempty"`
// The ID to this configration instance.
// Format: uuid
ConfigurationID strfmt.UUID `json:"configurationId,omitempty"`
// configuration status
ConfigurationStatus InstallConfigurationStatus `json:"configurationStatus,omitempty"`
// A UTC ISO-8601 Date-Time String
// Format: date-time
CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`
// The ID of the installed app.
// Format: uuid
InstalledAppID strfmt.UUID `json:"installedAppId,omitempty"`
// A UTC ISO-8601 Date-Time String
// Format: date-time
LastUpdatedDate strfmt.DateTime `json:"lastUpdatedDate,omitempty"`
}
InstallConfigurationDetail Encompasses both a configuration value, and any required permissions that maybe needed. swagger:model InstallConfigurationDetail
func (*InstallConfigurationDetail) MarshalBinary ¶
func (m *InstallConfigurationDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InstallConfigurationDetail) UnmarshalBinary ¶
func (m *InstallConfigurationDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InstallConfigurationStatus ¶
type InstallConfigurationStatus string
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.
swagger:model InstallConfigurationStatus
const ( // InstallConfigurationStatusSTAGED captures enum value "STAGED" InstallConfigurationStatusSTAGED InstallConfigurationStatus = "STAGED" // InstallConfigurationStatusDONE captures enum value "DONE" InstallConfigurationStatusDONE InstallConfigurationStatus = "DONE" // InstallConfigurationStatusAUTHORIZED captures enum value "AUTHORIZED" InstallConfigurationStatusAUTHORIZED InstallConfigurationStatus = "AUTHORIZED" // InstallConfigurationStatusREVOKED captures enum value "REVOKED" InstallConfigurationStatusREVOKED InstallConfigurationStatus = "REVOKED" )
type InstalledApp ¶
type InstalledApp struct {
// The ID of the app.
AppID string `json:"appId,omitempty"`
// A UTC ISO-8601 Date-Time String
// Format: date-time
CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`
// A user defined name for the installed app.
// Max Length: 64
DisplayName string `json:"displayName,omitempty"`
// The ID of the installed app.
// Format: uuid
InstalledAppID strfmt.UUID `json:"installedAppId,omitempty"`
// installed app status
InstalledAppStatus InstalledAppStatus `json:"installedAppStatus,omitempty"`
// installed app type
InstalledAppType InstalledAppType `json:"installedAppType,omitempty"`
// A UTC ISO-8601 Date-Time String
// Format: date-time
LastUpdatedDate strfmt.DateTime `json:"lastUpdatedDate,omitempty"`
// The ID of the location to which the installed app may belong.
// Format: uuid
LocationID strfmt.UUID `json:"locationId,omitempty"`
// owner
Owner *Owner `json:"owner,omitempty"`
// A reference to an upstream system. For example, Behaviors would reference the behaviorId.
//
ReferenceID string `json:"referenceId,omitempty"`
}
InstalledApp 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 InstalledAppStatus ¶
type InstalledAppStatus string
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.
swagger:model InstalledAppStatus
const ( // InstalledAppStatusPENDING captures enum value "PENDING" InstalledAppStatusPENDING InstalledAppStatus = "PENDING" // InstalledAppStatusAUTHORIZED captures enum value "AUTHORIZED" InstalledAppStatusAUTHORIZED InstalledAppStatus = "AUTHORIZED" // InstalledAppStatusREVOKED captures enum value "REVOKED" InstalledAppStatusREVOKED InstalledAppStatus = "REVOKED" // InstalledAppStatusDISABLED captures enum value "DISABLED" InstalledAppStatusDISABLED InstalledAppStatus = "DISABLED" )
type InstalledAppType ¶
type InstalledAppType string
InstalledAppType Denotes the type of installed app. swagger:model InstalledAppType
const ( // InstalledAppTypeLAMBDASMARTAPP captures enum value "LAMBDA_SMART_APP" InstalledAppTypeLAMBDASMARTAPP InstalledAppType = "LAMBDA_SMART_APP" // InstalledAppTypeWEBHOOKSMARTAPP captures enum value "WEBHOOK_SMART_APP" InstalledAppTypeWEBHOOKSMARTAPP InstalledAppType = "WEBHOOK_SMART_APP" // InstalledAppTypeBEHAVIOR captures enum value "BEHAVIOR" InstalledAppTypeBEHAVIOR InstalledAppType = "BEHAVIOR" )
type LambdaSmartApp ¶
type LambdaSmartApp struct {
// A list of AWS arns referencing a Lambda function.
Functions []string `json:"functions"`
}
LambdaSmartApp Details related to a Lambda Smart App implementation. This model will only be available for apps of type LAMBDA_SMART_APP.
swagger:model LambdaSmartApp
func (*LambdaSmartApp) MarshalBinary ¶
func (m *LambdaSmartApp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LambdaSmartApp) UnmarshalBinary ¶
func (m *LambdaSmartApp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Link ¶
type Link struct {
// An absolute URL linking to a resource.
Href string `json:"href,omitempty"`
}
Link link swagger:model Link
func (*Link) MarshalBinary ¶
MarshalBinary interface implementation
func (*Link) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Links ¶
type Links struct {
// next
Next *Link `json:"next,omitempty"`
// previous
Previous *Link `json:"previous,omitempty"`
}
Links links swagger:model Links
func (*Links) MarshalBinary ¶
MarshalBinary interface implementation
func (*Links) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type LocaleReference ¶
type LocaleReference struct {
// tag
Tag LocaleTag `json:"tag,omitempty"`
}
LocaleReference locale reference swagger:model LocaleReference
func (*LocaleReference) MarshalBinary ¶
func (m *LocaleReference) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LocaleReference) UnmarshalBinary ¶
func (m *LocaleReference) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LocaleTag ¶
type LocaleTag string
LocaleTag The tag of the locale as defined in [RFC bcp47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt). swagger:model LocaleTag
type Location ¶
type Location struct {
// A geographical latitude.
Latitude float32 `json:"latitude,omitempty"`
// An IETF BCP 47 language tag representing the chosen locale for this location.
Locale string `json:"locale,omitempty"`
// The ID of the location.
// Format: uuid
LocationID strfmt.UUID `json:"locationId,omitempty"`
// A geographical longitude.
Longitude float32 `json:"longitude,omitempty"`
// A nickname given for the location (eg. Home)
Name string `json:"name,omitempty"`
// The radius in meters around latitude and longitude which defines this location.
RegionRadius int32 `json:"regionRadius,omitempty"`
// temperature scale
// Enum: [F C]
TemperatureScale string `json:"temperatureScale,omitempty"`
// An ID matching the Java Time Zone ID of the location. Only available if latitude and longitude have been
// provided.
//
TimeZoneID string `json:"timeZoneId,omitempty"`
}
Location location swagger:model Location
func (*Location) MarshalBinary ¶
MarshalBinary interface implementation
func (*Location) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Mode ¶
type Mode struct {
// Globally unique id for the mode.
// Required: true
ID *string `json:"id"`
// A name provided by the User. Unique per location, updatable.
// Required: true
// Max Length: 25
// Min Length: 1
Label *string `json:"label"`
// A name provided when the mode was created. The name is unique per location, and can not be updated.
// Required: true
Name *string `json:"name"`
}
Mode mode swagger:model Mode
func (*Mode) MarshalBinary ¶
MarshalBinary interface implementation
func (*Mode) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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 ModeSubscriptionDetail ¶
type ModeSubscriptionDetail struct {
// The GUID for the location to subscribe to mode changes.
// Required: true
LocationID *string `json:"locationId"`
}
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. swagger:model ModeSubscriptionDetail
func (*ModeSubscriptionDetail) MarshalBinary ¶
func (m *ModeSubscriptionDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ModeSubscriptionDetail) UnmarshalBinary ¶
func (m *ModeSubscriptionDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ModesResponse ¶
type ModesResponse struct {
// items
// Required: true
// Max Items: 10
Items []*Mode `json:"items"`
}
ModesResponse modes response swagger:model ModesResponse
func (*ModesResponse) MarshalBinary ¶
func (m *ModesResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ModesResponse) UnmarshalBinary ¶
func (m *ModesResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OnceSchedule ¶
type OnceSchedule struct {
// overwrite
Overwrite bool `json:"overwrite,omitempty"`
// The time in millis from jan 1 1970 UTC for ONCE schedules. Must be less than 2 years from now.
// Required: true
Time *int64 `json:"time"`
}
OnceSchedule once schedule swagger:model OnceSchedule
func (*OnceSchedule) MarshalBinary ¶
func (m *OnceSchedule) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OnceSchedule) UnmarshalBinary ¶
func (m *OnceSchedule) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Owner ¶
type Owner struct {
// A global idenfifier for owner.
OwnerID string `json:"ownerId,omitempty"`
// The account type which owns the specific domain item.
// Enum: [USER]
OwnerType *string `json:"ownerType,omitempty"`
}
Owner A typed model which provides information around ownership of a specific domain. swagger:model Owner
func (*Owner) MarshalBinary ¶
MarshalBinary interface implementation
func (*Owner) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PagedApp ¶
type PagedApp struct {
// A globally unique identifier for an app.
// Format: uuid
AppID strfmt.UUID `json:"appId,omitempty"`
// 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.
//
AppName string `json:"appName,omitempty"`
// app type
AppType AppType `json:"appType,omitempty"`
// A UTC ISO-8601 Date-Time String
// Format: date-time
CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`
// A default description for an app.
//
// Max Length: 250
Description string `json:"description,omitempty"`
// A default display name for an app.
//
// Max Length: 75
DisplayName string `json:"displayName,omitempty"`
// A UTC ISO-8601 Date-Time String
// Format: date-time
LastUpdatedDate strfmt.DateTime `json:"lastUpdatedDate,omitempty"`
// owner
Owner *Owner `json:"owner,omitempty"`
}
PagedApp paged app swagger:model PagedApp
func (*PagedApp) MarshalBinary ¶
MarshalBinary interface implementation
func (*PagedApp) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PagedApps ¶
type PagedApps struct {
// links
Links *Links `json:"_links,omitempty"`
// items
Items []*PagedApp `json:"items"`
}
PagedApps Represents a single page of Apps available in an account. swagger:model PagedApps
func (*PagedApps) MarshalBinary ¶
MarshalBinary interface implementation
func (*PagedApps) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PagedCapabilities ¶
type PagedCapabilities struct {
// links
Links *Links `json:"_links,omitempty"`
// items
Items []*CapabilitySummary `json:"items"`
}
PagedCapabilities paged capabilities swagger:model PagedCapabilities
func (*PagedCapabilities) MarshalBinary ¶
func (m *PagedCapabilities) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PagedCapabilities) UnmarshalBinary ¶
func (m *PagedCapabilities) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PagedDeviceProfiles ¶
type PagedDeviceProfiles struct {
// links
Links *Links `json:"_links,omitempty"`
// items
Items []*DeviceProfile `json:"items"`
}
PagedDeviceProfiles paged device profiles swagger:model PagedDeviceProfiles
func (*PagedDeviceProfiles) MarshalBinary ¶
func (m *PagedDeviceProfiles) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PagedDeviceProfiles) UnmarshalBinary ¶
func (m *PagedDeviceProfiles) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PagedDevices ¶
type PagedDevices struct {
// links
Links *Links `json:"_links,omitempty"`
// items
Items []*Device `json:"items"`
}
PagedDevices A paginated array of devices. swagger:model PagedDevices
func (*PagedDevices) MarshalBinary ¶
func (m *PagedDevices) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PagedDevices) UnmarshalBinary ¶
func (m *PagedDevices) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PagedInstallConfigurations ¶
type PagedInstallConfigurations struct {
// links
Links *Links `json:"_links,omitempty"`
// items
Items []*InstallConfiguration `json:"items"`
}
PagedInstallConfigurations Represents a single page of InstallConfiguration models available for an InstalledApp. swagger:model PagedInstallConfigurations
func (*PagedInstallConfigurations) MarshalBinary ¶
func (m *PagedInstallConfigurations) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PagedInstallConfigurations) UnmarshalBinary ¶
func (m *PagedInstallConfigurations) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PagedInstalledApps ¶
type PagedInstalledApps struct {
// links
Links *Links `json:"_links,omitempty"`
// items
Items []*InstalledApp `json:"items"`
}
PagedInstalledApps Represents a single page of InstalledApps available in a user account. swagger:model PagedInstalledApps
func (*PagedInstalledApps) MarshalBinary ¶
func (m *PagedInstalledApps) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PagedInstalledApps) UnmarshalBinary ¶
func (m *PagedInstalledApps) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PagedLocation ¶
type PagedLocation struct {
// The ID of the location.
// Format: uuid
LocationID strfmt.UUID `json:"locationId,omitempty"`
// A nickname given for the location (eg. Home)
Name string `json:"name,omitempty"`
}
PagedLocation A slimmed down representation of the Location model. swagger:model PagedLocation
func (*PagedLocation) MarshalBinary ¶
func (m *PagedLocation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PagedLocation) UnmarshalBinary ¶
func (m *PagedLocation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PagedLocations ¶
type PagedLocations struct {
// links
Links *Links `json:"_links,omitempty"`
// items
Items []*PagedLocation `json:"items"`
}
PagedLocations Represents a single page of Locations available in a user account. swagger:model PagedLocations
func (*PagedLocations) MarshalBinary ¶
func (m *PagedLocations) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PagedLocations) UnmarshalBinary ¶
func (m *PagedLocations) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PagedSchedules ¶
type PagedSchedules struct {
// links
Links *Links `json:"_links,omitempty"`
// items
Items []*Schedule `json:"items"`
}
PagedSchedules An array of schedules swagger:model PagedSchedules
func (*PagedSchedules) MarshalBinary ¶
func (m *PagedSchedules) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PagedSchedules) UnmarshalBinary ¶
func (m *PagedSchedules) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PagedSubscriptions ¶
type PagedSubscriptions struct {
// links
Links *Links `json:"_links,omitempty"`
// items
Items []*Subscription `json:"items"`
}
PagedSubscriptions An array of subscriptions swagger:model PagedSubscriptions
func (*PagedSubscriptions) MarshalBinary ¶
func (m *PagedSubscriptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PagedSubscriptions) UnmarshalBinary ¶
func (m *PagedSubscriptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PatchTagsRequest ¶
type PatchTagsRequest struct {
// removals
Removals []string `json:"removals"`
// upserts
Upserts Tags `json:"upserts,omitempty"`
}
PatchTagsRequest A request object used to update a resource's tags. swagger:model PatchTagsRequest
func (*PatchTagsRequest) MarshalBinary ¶
func (m *PatchTagsRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PatchTagsRequest) UnmarshalBinary ¶
func (m *PatchTagsRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PatchTagsResponse ¶
type PatchTagsResponse struct {
// tags
Tags Tags `json:"tags,omitempty"`
}
PatchTagsResponse A response object containing the updated tags. swagger:model PatchTagsResponse
func (*PatchTagsResponse) MarshalBinary ¶
func (m *PatchTagsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PatchTagsResponse) UnmarshalBinary ¶
func (m *PatchTagsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PermissionConfig ¶
type PermissionConfig struct {
// permissions
// Max Items: 25
// Min Items: 1
Permissions []string `json:"permissions"`
}
PermissionConfig Required permissions for the installed app. swagger:model PermissionConfig
func (*PermissionConfig) MarshalBinary ¶
func (m *PermissionConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PermissionConfig) UnmarshalBinary ¶
func (m *PermissionConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneAction ¶
type SceneAction struct {
// device request
DeviceRequest *SceneDeviceRequest `json:"deviceRequest,omitempty"`
// mode request
ModeRequest *SceneModeRequest `json:"modeRequest,omitempty"`
// sleep request
SleepRequest *SceneSleepRequest `json:"sleepRequest,omitempty"`
}
SceneAction Possible scene actions, mutually exclusive swagger:model SceneAction
func (*SceneAction) MarshalBinary ¶
func (m *SceneAction) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneAction) UnmarshalBinary ¶
func (m *SceneAction) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneActionSequence ¶
type SceneActionSequence []*SceneAction
SceneActionSequence scene action sequence swagger:model SceneActionSequence
type SceneArgument ¶
type SceneArgument struct {
// the name of the command
Name string `json:"name,omitempty"`
// the schema of the command
Schema interface{} `json:"schema,omitempty"`
// The value being set for the capability command
Value interface{} `json:"value,omitempty"`
}
SceneArgument A capability command argument swagger:model SceneArgument
func (*SceneArgument) MarshalBinary ¶
func (m *SceneArgument) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneArgument) UnmarshalBinary ¶
func (m *SceneArgument) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneCapability ¶
type SceneCapability struct {
// The id of the capability
CapabilityID string `json:"capabilityId,omitempty"`
// Capability commands
Commands map[string]SceneCommand `json:"commands,omitempty"`
// The status of the capability
// Enum: [proposed live deprecated dead]
Status string `json:"status,omitempty"`
}
SceneCapability A device component capability swagger:model SceneCapability
func (*SceneCapability) MarshalBinary ¶
func (m *SceneCapability) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneCapability) UnmarshalBinary ¶
func (m *SceneCapability) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneCommand ¶
type SceneCommand struct {
// the command arguments
Arguments []*SceneArgument `json:"arguments"`
}
SceneCommand A component capability command swagger:model SceneCommand
func (*SceneCommand) MarshalBinary ¶
func (m *SceneCommand) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneCommand) UnmarshalBinary ¶
func (m *SceneCommand) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneComponent ¶
type SceneComponent struct {
// capabilities
Capabilities []*SceneCapability `json:"capabilities"`
// the id of the component
ComponentID string `json:"componentId,omitempty"`
}
SceneComponent A component of the scene device swagger:model SceneComponent
func (*SceneComponent) MarshalBinary ¶
func (m *SceneComponent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneComponent) UnmarshalBinary ¶
func (m *SceneComponent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneConfig ¶
type SceneConfig struct {
// permissions
// Max Items: 25
Permissions []string `json:"permissions"`
// 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 SceneDevice ¶
type SceneDevice struct {
// components
Components []*SceneComponent `json:"components"`
// the id of the device
DeviceID string `json:"deviceId,omitempty"`
// the label of the device
DeviceLabel string `json:"deviceLabel,omitempty"`
// the name of the device
DeviceName string `json:"deviceName,omitempty"`
// The identifier for the device's DeviceType.
DeviceTypeID string `json:"deviceTypeId,omitempty"`
// Location of the device
LocationID string `json:"locationId,omitempty"`
}
SceneDevice scene device swagger:model SceneDevice
func (*SceneDevice) MarshalBinary ¶
func (m *SceneDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneDevice) UnmarshalBinary ¶
func (m *SceneDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneDeviceRequest ¶
type SceneDeviceRequest struct {
// components
Components []*SceneComponent `json:"components"`
// the id of the device
DeviceID string `json:"deviceId,omitempty"`
}
SceneDeviceRequest JSON structure for a device when creating a Scene swagger:model SceneDeviceRequest
func (*SceneDeviceRequest) MarshalBinary ¶
func (m *SceneDeviceRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneDeviceRequest) UnmarshalBinary ¶
func (m *SceneDeviceRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneLifecycleDetail ¶
type SceneLifecycleDetail struct {
// The id of the location that both the app and scenes are in.
// Required: true
LocationID *string `json:"locationId"`
// A name for the subscription that will be passed to the installed app.
SubscriptionName string `json:"subscriptionName,omitempty"`
}
SceneLifecycleDetail Details of a subscription of source type SCENE_LIFECYCLE. swagger:model SceneLifecycleDetail
func (*SceneLifecycleDetail) MarshalBinary ¶
func (m *SceneLifecycleDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneLifecycleDetail) UnmarshalBinary ¶
func (m *SceneLifecycleDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneMode ¶
type SceneMode struct {
// the id of the mode
ModeID string `json:"modeId,omitempty"`
// the name of the mode
ModeName string `json:"modeName,omitempty"`
}
SceneMode The mode activated by the Scene swagger:model SceneMode
func (*SceneMode) MarshalBinary ¶
MarshalBinary interface implementation
func (*SceneMode) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SceneModeRequest ¶
type SceneModeRequest struct {
// The id of the mode
// Required: true
ModeID *string `json:"modeId"`
// The name of the mode
ModeName string `json:"modeName,omitempty"`
}
SceneModeRequest The mode to be activated by the Scene swagger:model SceneModeRequest
func (*SceneModeRequest) MarshalBinary ¶
func (m *SceneModeRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneModeRequest) UnmarshalBinary ¶
func (m *SceneModeRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ScenePagedResult ¶
type ScenePagedResult struct {
// links
Links *Links `json:"_links,omitempty"`
// items
Items []*SceneSummary `json:"items"`
}
ScenePagedResult scene paged result swagger:model ScenePagedResult
func (*ScenePagedResult) MarshalBinary ¶
func (m *ScenePagedResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ScenePagedResult) UnmarshalBinary ¶
func (m *ScenePagedResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneRequest ¶
type SceneRequest struct {
// devices
// Required: true
Devices []*SceneDeviceRequest `json:"devices"`
// The color of the icon
SceneColor string `json:"sceneColor,omitempty"`
// The name of the icon
SceneIcon string `json:"sceneIcon,omitempty"`
// The user-defined name of the Scene
// Required: true
SceneName *string `json:"sceneName"`
}
SceneRequest JSON body for creating or updating a Scene swagger:model SceneRequest
func (*SceneRequest) MarshalBinary ¶
func (m *SceneRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneRequest) UnmarshalBinary ¶
func (m *SceneRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneSleepRequest ¶
type SceneSleepRequest struct {
// Number of seconds to sleep the sequence
// Required: true
Seconds *int64 `json:"seconds"`
}
SceneSleepRequest Sleep a particular sequence swagger:model SceneSleepRequest
func (*SceneSleepRequest) MarshalBinary ¶
func (m *SceneSleepRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneSleepRequest) UnmarshalBinary ¶
func (m *SceneSleepRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SceneSummary ¶
type SceneSummary struct {
// Date-based version of the API with which the scene was created in format YYYYMMDD
APIVersion string `json:"apiVersion,omitempty"`
// The unique identifier of the backing behavior
BehaviorID string `json:"behaviorId,omitempty"`
// The unique identifier of the user that created the scene
CreatedBy string `json:"createdBy,omitempty"`
// The date the scene was created
// Format: date-time
CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`
// Whether or not this scene can be edited by the logged in user using the version of the app that made the request
Editable bool `json:"editable,omitempty"`
// The date the scene was last executed
// Format: date-time
LastExecutedDate strfmt.DateTime `json:"lastExecutedDate,omitempty"`
// The date the scene was last updated
// Format: date-time
LastUpdatedDate strfmt.DateTime `json:"lastUpdatedDate,omitempty"`
// Location of the Scene
LocationID string `json:"locationId,omitempty"`
// The color of the icon
SceneColor string `json:"sceneColor,omitempty"`
// The name of the icon
SceneIcon string `json:"sceneIcon,omitempty"`
// The unique identifier of the Scene
SceneID string `json:"sceneId,omitempty"`
// The user-defined name of the Scene
SceneName string `json:"sceneName,omitempty"`
}
SceneSummary scene summary swagger:model SceneSummary
func (*SceneSummary) MarshalBinary ¶
func (m *SceneSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SceneSummary) UnmarshalBinary ¶
func (m *SceneSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Schedule ¶
type Schedule struct {
// cron
Cron *CronSchedule `json:"cron,omitempty"`
// The ID of the installed app.
// Format: uuid
InstalledAppID strfmt.UUID `json:"installedAppId,omitempty"`
// The ID of the location the installed app is in.
// Format: uuid
LocationID strfmt.UUID `json:"locationId,omitempty"`
// The unique per installed app name of the schedule.
// Required: true
// Max Length: 36
// Min Length: 1
Name *string `json:"name"`
// list of scheduled execution times in millis from jan 1 1970 UTC
ScheduledExecutions []int64 `json:"scheduledExecutions"`
}
Schedule schedule swagger:model Schedule
func (*Schedule) MarshalBinary ¶
MarshalBinary interface implementation
func (*Schedule) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ScheduleRequest ¶
type ScheduleRequest struct {
// cron
Cron *CronSchedule `json:"cron,omitempty"`
// The unique per installed app name of the schedule.
// Required: true
// Max Length: 36
// Min Length: 1
Name *string `json:"name"`
// once
Once *OnceSchedule `json:"once,omitempty"`
}
ScheduleRequest schedule request swagger:model ScheduleRequest
func (*ScheduleRequest) MarshalBinary ¶
func (m *ScheduleRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ScheduleRequest) UnmarshalBinary ¶
func (m *ScheduleRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecurityArmStateDetail ¶
type SecurityArmStateDetail struct {
// The id of the location that both the app and the security system are in.
// Required: true
LocationID *string `json:"locationId"`
// A name for the subscription that will be passed to the installed app.
SubscriptionName string `json:"subscriptionName,omitempty"`
}
SecurityArmStateDetail Details of a subscription of souce type SECURITY_ARM_STATE swagger:model SecurityArmStateDetail
func (*SecurityArmStateDetail) MarshalBinary ¶
func (m *SecurityArmStateDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecurityArmStateDetail) UnmarshalBinary ¶
func (m *SecurityArmStateDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SmartAppDashboardCardEventRequest ¶
type SmartAppDashboardCardEventRequest struct {
// A developer defined dashboard card ID.
CardID string `json:"cardId,omitempty"`
// lifecycle
Lifecycle DashboardCardLifecycle `json:"lifecycle,omitempty"`
}
SmartAppDashboardCardEventRequest An event used to trigger a client action on a SmartApp dashboard card.
swagger:model SmartAppDashboardCardEventRequest
func (*SmartAppDashboardCardEventRequest) MarshalBinary ¶
func (m *SmartAppDashboardCardEventRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SmartAppDashboardCardEventRequest) UnmarshalBinary ¶
func (m *SmartAppDashboardCardEventRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SmartAppEventRequest ¶
type SmartAppEventRequest struct {
// 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.
//
Attributes map[string]string `json:"attributes,omitempty"`
// An arbitrary name for the custom SmartApp event. Typically useful as a hook for in-app routing.
Name string `json:"name,omitempty"`
}
SmartAppEventRequest smart app event request swagger:model SmartAppEventRequest
func (*SmartAppEventRequest) MarshalBinary ¶
func (m *SmartAppEventRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SmartAppEventRequest) UnmarshalBinary ¶
func (m *SmartAppEventRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StandardSuccessResponse ¶
type StandardSuccessResponse struct {
// status
// Enum: [success]
Status *string `json:"status,omitempty"`
}
StandardSuccessResponse {"status": "success"} swagger:model StandardSuccessResponse
func (*StandardSuccessResponse) MarshalBinary ¶
func (m *StandardSuccessResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StandardSuccessResponse) UnmarshalBinary ¶
func (m *StandardSuccessResponse) 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 Subscription ¶
type Subscription struct {
// capability
Capability *CapabilitySubscriptionDetail `json:"capability,omitempty"`
// device
Device *DeviceSubscriptionDetail `json:"device,omitempty"`
// The id of the subscription.
ID string `json:"id,omitempty"`
// The id of the subscribing app.
InstalledAppID string `json:"installedAppId,omitempty"`
// source type
SourceType SubscriptionSource `json:"sourceType,omitempty"`
}
Subscription subscription swagger:model Subscription
func (*Subscription) MarshalBinary ¶
func (m *Subscription) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Subscription) UnmarshalBinary ¶
func (m *Subscription) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SubscriptionDelete ¶
type SubscriptionDelete struct {
// count
Count int32 `json:"count,omitempty"`
}
SubscriptionDelete The number of deleted subscriptions swagger:model SubscriptionDelete
func (*SubscriptionDelete) MarshalBinary ¶
func (m *SubscriptionDelete) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SubscriptionDelete) UnmarshalBinary ¶
func (m *SubscriptionDelete) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SubscriptionRequest ¶
type SubscriptionRequest struct {
// capability
Capability *CapabilitySubscriptionDetail `json:"capability,omitempty"`
// device
Device *DeviceSubscriptionDetail `json:"device,omitempty"`
// source type
// Required: true
SourceType SubscriptionSource `json:"sourceType"`
}
SubscriptionRequest subscription request swagger:model SubscriptionRequest
func (*SubscriptionRequest) MarshalBinary ¶
func (m *SubscriptionRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SubscriptionRequest) UnmarshalBinary ¶
func (m *SubscriptionRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SubscriptionSource ¶
type SubscriptionSource string
SubscriptionSource The type of the event that is being subscribed to. swagger:model SubscriptionSource
const ( // SubscriptionSourceDEVICE captures enum value "DEVICE" SubscriptionSourceDEVICE SubscriptionSource = "DEVICE" // SubscriptionSourceCAPABILITY captures enum value "CAPABILITY" SubscriptionSourceCAPABILITY SubscriptionSource = "CAPABILITY" )
type Tags ¶
Tags A map of user-defined tags which can be used to associate arbitrary metadata to a resource, and can be useful for filtering.
* Key length must be between 1 and 64 (inclusive) Unicode characters in UTF-8 * Value length must be between 1 and 256 (inclusive) Unicode characters in UTF-8 * Case sensitive * Maximum number of tags per resource: 25 * Reserved prefix — `st:` * ST-generated tag names and values are automatically assigned the `st:` prefix, which you cannot assign. * Use each key only once for each resource. If you attempt to use the same key twice on the same resource the last key wins. * You cannot tag a resource at the same time you create it. Tagging requires a separate action after the resource is created. * 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 to your tag.
swagger:model Tags
type UpdateAppOAuthRequest ¶
type UpdateAppOAuthRequest struct {
// A name given to the OAuth Client.
// Required: true
ClientName *string `json:"clientName"`
// A list of SmartThings API OAuth scope identifiers that maybe required to execute your integration.
// Required: true
Scope []string `json:"scope"`
}
UpdateAppOAuthRequest update app o auth request swagger:model UpdateAppOAuthRequest
func (*UpdateAppOAuthRequest) MarshalBinary ¶
func (m *UpdateAppOAuthRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateAppOAuthRequest) UnmarshalBinary ¶
func (m *UpdateAppOAuthRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateAppRequest ¶
type UpdateAppRequest struct {
// app type
// Required: true
AppType AppType `json:"appType"`
// A default description for an app.
//
// Required: true
// Max Length: 250
Description *string `json:"description"`
// A default display name for an app.
//
// Required: true
// Max Length: 75
DisplayName *string `json:"displayName"`
// icon image
IconImage *IconImage `json:"iconImage,omitempty"`
// lambda smart app
LambdaSmartApp *CreateOrUpdateLambdaSmartAppRequest `json:"lambdaSmartApp,omitempty"`
// Inform the installation systems that a particular app can only be installed once within a user's account.
//
SingleInstance *bool `json:"singleInstance,omitempty"`
// webhook smart app
WebhookSmartApp *CreateOrUpdateWebhookSmartAppRequest `json:"webhookSmartApp,omitempty"`
}
UpdateAppRequest update app request swagger:model UpdateAppRequest
func (*UpdateAppRequest) MarshalBinary ¶
func (m *UpdateAppRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateAppRequest) UnmarshalBinary ¶
func (m *UpdateAppRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateAppSettingsRequest ¶
type UpdateAppSettingsRequest struct {
// settings
Settings map[string]string `json:"settings,omitempty"`
}
UpdateAppSettingsRequest Settings for a given app swagger:model UpdateAppSettingsRequest
func (*UpdateAppSettingsRequest) MarshalBinary ¶
func (m *UpdateAppSettingsRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateAppSettingsRequest) UnmarshalBinary ¶
func (m *UpdateAppSettingsRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateAppSettingsResponse ¶
type UpdateAppSettingsResponse struct {
// settings
Settings map[string]string `json:"settings,omitempty"`
}
UpdateAppSettingsResponse Settings for a given app swagger:model UpdateAppSettingsResponse
func (*UpdateAppSettingsResponse) MarshalBinary ¶
func (m *UpdateAppSettingsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateAppSettingsResponse) UnmarshalBinary ¶
func (m *UpdateAppSettingsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateDeviceProfileRequest ¶
type UpdateDeviceProfileRequest struct {
// A list of `[ 1..10 ]` components for this profile.
// Max Items: 10
// Min Items: 1
Components []*DeviceComponentReference `json:"components"`
// metadata
Metadata DeviceProfileMetadata `json:"metadata,omitempty"`
}
UpdateDeviceProfileRequest update device profile request swagger:model UpdateDeviceProfileRequest
func (*UpdateDeviceProfileRequest) MarshalBinary ¶
func (m *UpdateDeviceProfileRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateDeviceProfileRequest) UnmarshalBinary ¶
func (m *UpdateDeviceProfileRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateDeviceRequest ¶
type UpdateDeviceRequest struct {
// The label for the device.
Label string `json:"label,omitempty"`
}
UpdateDeviceRequest update device request swagger:model UpdateDeviceRequest
func (*UpdateDeviceRequest) MarshalBinary ¶
func (m *UpdateDeviceRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateDeviceRequest) UnmarshalBinary ¶
func (m *UpdateDeviceRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateLocationRequest ¶
type UpdateLocationRequest struct {
// A geographical latitude.
Latitude float32 `json:"latitude,omitempty"`
// An IETF BCP 47 language tag representing the chosen locale for this location.
Locale string `json:"locale,omitempty"`
// A geographical longitude.
Longitude float32 `json:"longitude,omitempty"`
// A nickname for the location.
Name string `json:"name,omitempty"`
// The radius in meters around latitude and longitude which defines this location.
RegionRadius int64 `json:"regionRadius,omitempty"`
// The desired temperature scale used within location.
// Enum: [F C]
TemperatureScale string `json:"temperatureScale,omitempty"`
}
UpdateLocationRequest update location request swagger:model UpdateLocationRequest
func (*UpdateLocationRequest) MarshalBinary ¶
func (m *UpdateLocationRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateLocationRequest) UnmarshalBinary ¶
func (m *UpdateLocationRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateModeRequest ¶
type UpdateModeRequest struct {
// A label provided by the User.
// Required: true
// Max Length: 25
// Min Length: 1
Label *string `json:"label"`
}
UpdateModeRequest update mode request swagger:model UpdateModeRequest
func (*UpdateModeRequest) MarshalBinary ¶
func (m *UpdateModeRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateModeRequest) UnmarshalBinary ¶
func (m *UpdateModeRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateTagsRequest ¶
type UpdateTagsRequest struct {
// tags
Tags Tags `json:"tags,omitempty"`
}
UpdateTagsRequest A request object used to update a resource's tags. swagger:model UpdateTagsRequest
func (*UpdateTagsRequest) MarshalBinary ¶
func (m *UpdateTagsRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateTagsRequest) UnmarshalBinary ¶
func (m *UpdateTagsRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateTagsResponse ¶
type UpdateTagsResponse struct {
// tags
Tags Tags `json:"tags,omitempty"`
}
UpdateTagsResponse A response object containing the updated tags. swagger:model UpdateTagsResponse
func (*UpdateTagsResponse) MarshalBinary ¶
func (m *UpdateTagsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateTagsResponse) UnmarshalBinary ¶
func (m *UpdateTagsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type WebhookSmartApp ¶
type WebhookSmartApp struct {
// The public half of an RSA key pair. Useful for verifying a Webhook execution request signature to
// ensure it came from SmartThings.
//
PublicKey string `json:"publicKey,omitempty"`
// A URL that should be invoked during execution.
TargetURL string `json:"targetUrl,omitempty"`
}
WebhookSmartApp Details related to a Webhook Smart App implementation. This model will only be available for apps of type WEBHOOK_SMART_APP.
swagger:model WebhookSmartApp
func (*WebhookSmartApp) MarshalBinary ¶
func (m *WebhookSmartApp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WebhookSmartApp) UnmarshalBinary ¶
func (m *WebhookSmartApp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
¶
- app.go
- app_device_details.go
- app_o_auth.go
- app_type.go
- argument.go
- attribute_state.go
- capability.go
- capability_attribute.go
- capability_command.go
- capability_data_type.go
- capability_reference.go
- capability_status.go
- capability_subscription_detail.go
- capability_summary.go
- change_mode_request.go
- component_status.go
- component_translations.go
- config_entries.go
- config_entry.go
- config_map.go
- create_app_request.go
- create_app_response.go
- create_device_commands_response.go
- create_device_events_response.go
- create_device_profile_request.go
- create_installed_app_events_request.go
- create_installed_app_events_response.go
- create_location_request.go
- create_or_update_app_request.go
- create_or_update_lambda_smart_app_request.go
- create_or_update_webhook_smart_app_request.go
- cron_schedule.go
- dashboard_card_lifecycle.go
- delete_app_response.go
- delete_device_commands_response.go
- delete_device_profile_response.go
- delete_installed_app_response.go
- delete_location_response.go
- delete_schedule_response.go
- device.go
- device_command.go
- device_commands_request.go
- device_component.go
- device_component_reference.go
- device_config.go
- device_events_request.go
- device_health_detail.go
- device_install_request.go
- device_integration_type.go
- device_lifecycle_detail.go
- device_profile.go
- device_profile_locale_translations.go
- device_profile_metadata.go
- device_profile_reference.go
- device_profile_status.go
- device_profile_translations.go
- device_state_event.go
- device_status.go
- device_subscription_detail.go
- dth_device_details.go
- error.go
- error_response.go
- generate_app_o_auth_request.go
- generate_app_o_auth_response.go
- get_app_settings_response.go
- get_tags_response.go
- hub_health_detail.go
- icon_image.go
- install_configuration.go
- install_configuration_detail.go
- install_configuration_status.go
- installed_app.go
- installed_app_status.go
- installed_app_type.go
- lambda_smart_app.go
- link.go
- links.go
- locale_reference.go
- locale_tag.go
- location.go
- mode.go
- mode_config.go
- mode_subscription_detail.go
- modes_response.go
- once_schedule.go
- owner.go
- paged_app.go
- paged_apps.go
- paged_capabilities.go
- paged_device_profiles.go
- paged_devices.go
- paged_install_configurations.go
- paged_installed_apps.go
- paged_location.go
- paged_locations.go
- paged_schedules.go
- paged_subscriptions.go
- patch_tags_request.go
- patch_tags_response.go
- permission_config.go
- scene_action.go
- scene_action_sequence.go
- scene_argument.go
- scene_capability.go
- scene_command.go
- scene_component.go
- scene_config.go
- scene_device.go
- scene_device_request.go
- scene_lifecycle_detail.go
- scene_mode.go
- scene_mode_request.go
- scene_paged_result.go
- scene_request.go
- scene_sleep_request.go
- scene_summary.go
- schedule.go
- schedule_request.go
- security_arm_state_detail.go
- smart_app_dashboard_card_event_request.go
- smart_app_event_request.go
- standard_success_response.go
- string_config.go
- subscription.go
- subscription_delete.go
- subscription_request.go
- subscription_source.go
- tags.go
- update_app_o_auth_request.go
- update_app_request.go
- update_app_settings_request.go
- update_app_settings_response.go
- update_device_profile_request.go
- update_device_request.go
- update_location_request.go
- update_mode_request.go
- update_tags_request.go
- update_tags_response.go
- webhook_smart_app.go