############################ Copyrights and license ############################ # # # Copyright 2012 Vincent Jacques # # Copyright 2012 Zearin # # Copyright 2013 AKFish # # Copyright 2013 Vincent Jacques # # Copyright 2014 Vincent Jacques # # Copyright 2016 Jannis Gebauer # # Copyright 2016 Peter Buckley # # Copyright 2018 Wan Liuyang # # Copyright 2018 sfdye # # Copyright 2019 Steve Kowalik # # Copyright 2019 Wan Liuyang # # Copyright 2020 Steve Kowalik # # Copyright 2023 Andrew Dawes <53574062+AndrewJDawes@users.noreply.github.com> # # Copyright 2023 Enrico Minack # # Copyright 2023 Mauricio Alejandro Martínez Pacheco # # Copyright 2023 Trim21 # # Copyright 2024 Enrico Minack # # Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2025 Enrico Minack # # # # This file is part of PyGithub. # # http://pygithub.readthedocs.io/ # # # # PyGithub is free software: you can redistribute it and/or modify it under # # the terms of the GNU Lesser General Public License as published by the Free # # Software Foundation, either version 3 of the License, or (at your option) # # any later version. # # # # PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY # # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more # # details. # # # # You should have received a copy of the GNU Lesser General Public License # # along with PyGithub. If not, see . # # # ################################################################################ from datetime import datetime from typing import Any, Dict from github.GithubObject import Attribute, CompletableGithubObject, NotSet class Secret(CompletableGithubObject): """ This class represents a GitHub secret. The reference can be found here https://docs.github.com/en/rest/actions/secrets """ def _initAttributes(self) -> None: self._created_at: Attribute[datetime] = NotSet self._name: Attribute[str] = NotSet self._secrets_url: Attribute[str] = NotSet self._updated_at: Attribute[datetime] = NotSet self._url: Attribute[str] = NotSet def __repr__(self) -> str: return self.get__repr__({"name": self.name}) @property def created_at(self) -> datetime: """ :type: datetime.datetime """ self._completeIfNotSet(self._created_at) return self._created_at.value @property def name(self) -> str: """ :type: string """ self._completeIfNotSet(self._name) return self._name.value @property def secrets_url(self) -> str: """ :type: string """ return self._secrets_url.value @property def updated_at(self) -> datetime: """ :type: datetime.datetime """ self._completeIfNotSet(self._updated_at) return self._updated_at.value @property def url(self) -> str: """ :type: string """ # Construct url from secrets_url and name, if self._url. is not set if self._url is NotSet: self._url = self._makeStringAttribute(self.secrets_url + "/" + self.name) return self._url.value def delete(self) -> None: """ :calls: `DELETE {secret_url} `_ :rtype: None """ self._requester.requestJsonAndCheck("DELETE", self.url) def _useAttributes(self, attributes: Dict[str, Any]) -> None: if "created_at" in attributes: self._created_at = self._makeDatetimeAttribute(attributes["created_at"]) if "name" in attributes: self._name = self._makeStringAttribute(attributes["name"]) if "secrets_url" in attributes: self._secrets_url = self._makeStringAttribute(attributes["secrets_url"]) if "updated_at" in attributes: self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"]) if "url" in attributes: self._url = self._makeStringAttribute(attributes["url"])