Skip to content
This repository was archived by the owner on Jun 28, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions seamapi/access_codes.py
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,68 @@ def create(
success_res: Any = action_attempt.result
return AccessCode.from_dict(success_res["access_code"])

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,
) -> AccessCode:
"""Updates an access code on a device.

Parameters
----------
access_code: AccessCodeId or AccessCode
Access code id or Access code to update
device : DeviceId or Device
New device to move access code to
name : str, optional
Access code name
code : str, optional
Access code value
starts_at : str, optional
Time when access code becomes effective
ends_at : str, optional
Time when access code ceases to be effective

Raises
------
Exception
If the API request wasn't successful.

Returns
------
AccessCode
"""

access_code_id = to_access_code_id(access_code)
update_payload = {"access_code_id": access_code_id}
if device is not None:
update_payload["device_id"] = to_device_id(device)
if name is not None:
update_payload["name"] = name
if code is not None:
update_payload["code"] = code
if starts_at is not None:
update_payload["starts_at"] = starts_at
if ends_at is not None:
update_payload["ends_at"] = ends_at
res = requests.post(
f"{self.seam.api_url}/access_codes/update",
headers={"Authorization": f"Bearer {self.seam.api_key}"},
json=update_payload,
)
if not res.ok:
raise Exception(res.text)
action_attempt = self.seam.action_attempts.poll_until_ready(
res.json()["action_attempt"]["action_attempt_id"]
)
success_res: Any = action_attempt.result
return AccessCode.from_dict(success_res["access_code"])


def delete(
self,
access_code: Union[AccessCodeId, AccessCode],
Expand Down
12 changes: 12 additions & 0 deletions seamapi/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,18 @@ def create(
) -> 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,
) -> AccessCode:
raise NotImplementedError

@abc.abstractmethod
def delete(
self,
Expand Down
3 changes: 3 additions & 0 deletions tests/access_codes/test_access_codes.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,8 @@ def test_access_codes(seam: Seam):
access_code = seam.access_codes.get(created_access_code.access_code_id)
assert access_code.code == "4444"

access_code = seam.access_codes.update(access_code, name="Updated name")
assert access_code.name == "Updated name"

delete_action_attempt = seam.access_codes.delete(created_access_code)
assert delete_action_attempt.status == "success"