This repository was archived by the owner on Jun 28, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathtypes.py
More file actions
303 lines (249 loc) · 7.78 KB
/
types.py
File metadata and controls
303 lines (249 loc) · 7.78 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
# TODO this file should eventually be generated by looking at openapi.json
import abc
from typing import List, Optional, Union, Dict, Any
from dataclasses import dataclass
from dataclasses_json import dataclass_json
from seamapi.utils.deep_attr_dict import DeepAttrDict
AccessCodeId = str
ActionAttemptId = str
DeviceId = str
AcceptedProvider = str # e.g. august or noiseaware
ConnectWebviewId = str
ConnectedAccountId = str
Email = str
DeviceType = str # e.g. august_lock
WorkspaceId = str
class SeamAPIException(Exception):
def __init__(self, status_code: int, request_id: str, metadata: Optional[Dict[str, any]]):
self.status_code = status_code
self.request_id = request_id
self.metadata = metadata
super().__init__(f"SeamAPIException: status={status_code}, request_id={request_id}, metadata={metadata}")
class ActionAttemptFailedException(Exception):
def __init__(
self,
action_attempt_id: Optional[str] = None,
action_type: Optional[str] = None,
error_type: Optional[str] = None,
error_message: Optional[str] = None,
):
self.action_attempt_id = action_attempt_id
self.action_type = action_type
self.error_type = error_type
self.error_message = error_message
super().__init__(
f'Action Attempt for "{action_type}" Failed. {error_type}: {error_message} (action_attempt_id={action_attempt_id})'
)
@dataclass
class Device:
device_id: DeviceId
device_type: str
location: Optional[Dict[str, Any]]
properties: Any
capabilities_supported: List[str]
errors: List[Dict[str, Any]]
@staticmethod
def from_dict(d: Dict[str, Any]):
return Device(
device_id=d["device_id"],
device_type=d["device_type"],
location=d.get("location", None),
properties=DeepAttrDict(d["properties"]),
capabilities_supported=d["capabilities_supported"],
errors=d["errors"],
)
@dataclass
class Event:
event_id: str
noiseaware_id: str
activity_zone_id: str
event_class: Union[str, None]
event_type: Union[str, None]
duration: Union[int, None]
local_end_time: Union[str, None]
local_start_time: Union[str, None]
start_time: Union[str, None]
end_time: Union[str, None]
created_at: Union[str, None]
@dataclass_json
@dataclass
class ActionAttemptError:
type: str
message: str
@dataclass_json
@dataclass
class ActionAttempt:
action_attempt_id: str
action_type: str
status: str
result: Optional[Any]
error: Optional[ActionAttemptError]
@dataclass_json
@dataclass
class Workspace:
workspace_id: str
name: str
is_sandbox: bool
@dataclass_json
@dataclass
class ConnectWebview:
workspace_id: str
connect_webview_id: str
status: str
url: str
login_successful: bool
device_selection_mode: str
any_provider_allowed: bool
any_device_allowed: bool
created_at: str
connected_account_id: Optional[str] = None
authorized_at: Optional[str] = None
custom_redirect_url: Optional[str] = None
accepted_providers: Optional[List[AcceptedProvider]] = None
accepted_devices: Optional[List[str]] = None
@dataclass_json
@dataclass
class ConnectedAccount:
connected_account_id: str
created_at: str
user_identifier: str
account_type: str
errors: List[str]
@dataclass_json
@dataclass
class AccessCode:
access_code_id: str
type: str
code: str
starts_at: Optional[str] = None
ends_at: Optional[str] = None
name: Optional[str] = ""
status: Optional[str] = None
class AbstractActionAttempts(abc.ABC):
@abc.abstractmethod
def get(
self, action_attempt: Union[ActionAttemptId, ActionAttempt]
) -> ActionAttempt:
raise NotImplementedError
@abc.abstractmethod
def poll_until_ready(
self,
action_attempt: Union[ActionAttemptId, ActionAttempt],
should_raise: bool = True,
) -> ActionAttempt:
raise NotImplementedError
class AbstractLocks(abc.ABC):
@abc.abstractmethod
def list(self, connected_account: Optional[str] = None) -> List[Device]:
raise NotImplementedError
@abc.abstractmethod
def get(self, device: Union[DeviceId, Device]) -> Device:
raise NotImplementedError
@abc.abstractmethod
def lock_door(self, device: Union[DeviceId, Device]) -> ActionAttempt:
raise NotImplementedError
@abc.abstractmethod
def unlock_door(self, device: Union[DeviceId, Device]) -> ActionAttempt:
raise NotImplementedError
class AbstractAccessCodes(abc.ABC):
@abc.abstractmethod
def list(self, device: Union[DeviceId, Device]) -> List[AccessCode]:
raise NotImplementedError
@abc.abstractmethod
def get(
self,
access_code: Union[AccessCodeId, AccessCode],
) -> AccessCode:
raise NotImplementedError
@abc.abstractmethod
def create(
self, device: Union[DeviceId, Device], name: str, code: str
) -> AccessCode:
raise NotImplementedError
@abc.abstractmethod
def update(
self,
access_code: Union[AccessCodeId, AccessCode],
device: Optional[Union[DeviceId, Device]] = None,
name: Optional[str] = None,
code: Optional[str] = None,
starts_at: Optional[str] = None,
ends_at: Optional[str] = None,
status: Optional[str] = None,
) -> AccessCode:
raise NotImplementedError
@abc.abstractmethod
def delete(
self,
access_code: Union[AccessCodeId, AccessCode],
) -> ActionAttempt:
raise NotImplementedError
class AbstractDevices(abc.ABC):
@abc.abstractmethod
def list(self) -> List[Device]:
raise NotImplementedError
@abc.abstractmethod
def get(
self,
device: Optional[Union[DeviceId, Device]] = None,
name: Optional[str] = None,
) -> Device:
raise NotImplementedError
class AbstractEvents(abc.ABC):
@abc.abstractmethod
def list(self) -> List[Event]:
raise NotImplementedError
class AbstractWorkspaces(abc.ABC):
@abc.abstractmethod
def list(self) -> List[Workspace]:
raise NotImplementedError
@abc.abstractmethod
def get(self, workspace_id: Optional[str] = None) -> Workspace:
raise NotImplementedError
@abc.abstractmethod
def reset_sandbox(self) -> None:
raise NotImplementedError
class AbstractConnectWebviews(abc.ABC):
@abc.abstractmethod
def list(self) -> List[ConnectWebview]:
raise NotImplementedError
@abc.abstractmethod
def get(self, connect_webview_id: str) -> ConnectWebview:
raise NotImplementedError
@abc.abstractmethod
def create(
self, accepted_providers: Optional[List[AcceptedProvider]] = None
) -> ConnectWebview:
raise NotImplementedError
class AbstractConnectedAccounts(abc.ABC):
@abc.abstractmethod
def list(self) -> List[ConnectedAccount]:
raise NotImplementedError
@abc.abstractmethod
def get(
self, connected_account: Union[ConnectedAccountId, ConnectedAccount]
) -> ConnectedAccount:
raise NotImplementedError
@dataclass
class AbstractRoutes(abc.ABC):
workspaces: AbstractWorkspaces
connect_webviews: AbstractConnectWebviews
locks: AbstractLocks
devices: AbstractDevices
access_codes: AbstractAccessCodes
action_attempts: AbstractActionAttempts
@abc.abstractmethod
def make_request(self, method: str, path: str, **kwargs) -> Any:
raise NotImplementedError
@dataclass
class AbstractSeam(AbstractRoutes):
api_key: str
api_url: str
@abc.abstractmethod
def __init__(self, api_key: Optional[str] = None):
raise NotImplementedError
@dataclass_json
@dataclass
class ResetSandBoxResponse:
message: str
ok: bool