Module `smartapp.api.models`

Expand source code

from __future__ import annotations

from enum import Enum
from typing import List, Optional

from pydantic import BaseModel

from smartapp.api.models import smartthings, smartapp

LifecycleBase     = smartapp.LifecycleBase
Install           = smartapp.Install
Configuration     = smartapp.Configuration
Confirmation      = smartapp.Confirmation
Update            = smartapp.Update
Event             = smartapp.Event
EventType         = smartapp.EventType
LifecycleResponse = smartapp.LifecycleResponse
SubscriptionType  = smartapp.SubscriptionType

class AuthToken(BaseModel):
    access_token:      Optional[str]
    refresh_token:     Optional[str]
    token_type:        Optional[str]
    error:             Optional[str]
    error_description: Optional[str]

class TokenRefresh(BaseModel):
    grant_type:    str
    refresh_token: str

class Version(BaseModel):
    version: str

class DeviceCollection(BaseModel):
    items: List[smartthings.Device] = []

class InstalledAppCollection(BaseModel):
    items: List[smartthings.InstalledApp] = []

class SubscriptionCollection(BaseModel):
    items: List[smartthings.Subscription] = []

class AllLifecycles(smartapp.LifecycleBase):
    configurationData:  Optional[smartapp.ConfigurationData]
    confirmationData:   Optional[smartapp.ConfirmationData]
    eventData:          Optional[smartapp.EventData]
    installData:        Optional[smartapp.InstallData]
    updateData:         Optional[smartapp.UpdateData]
    oAuthCallbackData:  Optional[smartapp.OAuthCallbackData]
    uinstallData:       Optional[smartapp.UninstallData]
    pingData:           Optional[smartapp.PingData]

Sub-modules

smartapp.api.models.smartapp

Classes

class AllLifecycles (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class AllLifecycles(smartapp.LifecycleBase):
    configurationData:  Optional[smartapp.ConfigurationData]
    confirmationData:   Optional[smartapp.ConfirmationData]
    eventData:          Optional[smartapp.EventData]
    installData:        Optional[smartapp.InstallData]
    updateData:         Optional[smartapp.UpdateData]
    oAuthCallbackData:  Optional[smartapp.OAuthCallbackData]
    uinstallData:       Optional[smartapp.UninstallData]
    pingData:           Optional[smartapp.PingData]

Ancestors

LifecycleBase
pydantic.main.BaseModel
pydantic.utils.Representation

Class variables

var configurationData : Optional[ConfigurationData]
var confirmationData : Optional[ConfirmationData]
var eventData : Optional[EventData]
var installData : Optional[InstallData]
var oAuthCallbackData : Optional[OAuthCallbackData]
var pingData : Optional[PingData]
var uinstallData : Optional[UninstallData]
var updateData : Optional[UpdateData]

class AuthToken (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class AuthToken(BaseModel):
    access_token:      Optional[str]
    refresh_token:     Optional[str]
    token_type:        Optional[str]
    error:             Optional[str]
    error_description: Optional[str]

Ancestors

pydantic.main.BaseModel
pydantic.utils.Representation

Class variables

var access_token : Optional[str]
var error : Optional[str]
var error_description : Optional[str]
var refresh_token : Optional[str]
var token_type : Optional[str]

class DeviceCollection (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class DeviceCollection(BaseModel):
    items: List[smartthings.Device] = []

Ancestors

pydantic.main.BaseModel
pydantic.utils.Representation

Class variables

var items : List[smartapp.api.models.smartthings.Device]

class InstalledAppCollection (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class InstalledAppCollection(BaseModel):
    items: List[smartthings.InstalledApp] = []

Ancestors

pydantic.main.BaseModel
pydantic.utils.Representation

Class variables

var items : List[smartapp.api.models.smartthings.InstalledApp]

class SubscriptionCollection (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class SubscriptionCollection(BaseModel):
    items: List[smartthings.Subscription] = []

Ancestors

pydantic.main.BaseModel
pydantic.utils.Representation

Class variables

var items : List[smartapp.api.models.smartthings.Subscription]

class TokenRefresh (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class TokenRefresh(BaseModel):
    grant_type:    str
    refresh_token: str

Ancestors

pydantic.main.BaseModel
pydantic.utils.Representation

Class variables

var grant_type : str
var refresh_token : str

class Version (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class Version(BaseModel):
    version: str

Ancestors

pydantic.main.BaseModel
pydantic.utils.Representation

Subclasses

pydantic.main.Version

Class variables

var version : str