coretex.entities.secret.secret.Secret Class Reference

Inheritance diagram for coretex.entities.secret.secret.Secret:

Public Member Functions
Self	decrypted (self, Optional[RSAPrivateKey] key=None)
bool	refresh (self, Optional[Dict[str, Any]] jsonObject=None)
bool	update (self, **Any kwargs)
Self	fetchById (cls, int objectId, **Any kwargs)
Self	fetchByName (cls, str name)
Self	fetchNodeSecret (cls, str name, str accessToken)

Detailed Description

    Represents base Secret entity from Coretex.ai

Definition at line 32 of file secret.py.

Member Function Documentation

decrypted()

Self coretex.entities.secret.secret.Secret.decrypted	(		self,
		Optional[RSAPrivateKey]	key = None
	)

    Returns
    -------
    Self -> Decrypted Coretex Secret

Definition at line 54 of file secret.py.

    def decrypted(self, key: Optional[RSAPrivateKey] = None) -> Self:
        """
            Returns
            -------
            Self -> Decrypted Coretex Secret
        """
 
        if key is None:
            key = rsa.getPrivateKey()
 
        decrypted = copy.deepcopy(self)
 
        for field in self._encryptedFields():
            if not field in decrypted.__dict__:
                raise AttributeError(f"\"{type(decrypted)}\".\"{field}\" not found")
 
            value = decrypted.__dict__[field]
            if not isinstance(value, str):
                raise TypeError(f"Expected \"str\" received \"{type(value)}\"")
 
            decrypted.__dict__[field] = rsa.decrypt(key, b64decode(value)).decode("utf-8")
 
        return decrypted
 

fetchById()

Self coretex.entities.secret.secret.Secret.fetchById	(		cls,
		int	objectId,
		**Any	kwargs
	)

    Secret does not support this method

Definition at line 97 of file secret.py.

    def fetchById(cls, objectId: int, **kwargs: Any) -> Self:
        """
            Secret does not support this method
        """
 
        return NotImplemented
 

fetchByName()

Self coretex.entities.secret.secret.Secret.fetchByName	(		cls,
		str	name
	)

    Fetches a single Secret with the matching name

    Parameters
    ----------
    name : str
        name of the Secret which is fetched

    Returns
    -------
    Self -> fetched Secret

    Raises
    ------
    NetworkRequestError -> If the request for fetching failed

Definition at line 105 of file secret.py.

    def fetchByName(cls, name: str) -> Self:
        """
            Fetches a single Secret with the matching name
 
            Parameters
            ----------
            name : str
                name of the Secret which is fetched
 
            Returns
            -------
            Self -> fetched Secret
 
            Raises
            ------
            NetworkRequestError -> If the request for fetching failed
        """
 
        response = networkManager.get(f"{cls._endpoint()}/data", {
            "name": name
        })
 
        if response.hasFailed():
            raise NetworkRequestError(response, f"Failed to fetch Secret \"{name}\"")
 
        return cls.decode(response.getJson(dict))
 

fetchNodeSecret()

Self coretex.entities.secret.secret.Secret.fetchNodeSecret	(		cls,
		str	name,
		str	accessToken
	)

    Fetches a single Node Secret with the matching name

    Parameters
    ----------
    name : str
        name of the Node Secret which is fetched
    accessToken : str
        Node access token

    Returns
    -------
    Self -> fetched Node Secret

    Raises
    ------
    NetworkRequestError -> If the request for fetching failed

Definition at line 133 of file secret.py.

    def fetchNodeSecret(cls, name: str, accessToken: str) -> Self:
        """
            Fetches a single Node Secret with the matching name
 
            Parameters
            ----------
            name : str
                name of the Node Secret which is fetched
            accessToken : str
                Node access token
 
            Returns
            -------
            Self -> fetched Node Secret
 
            Raises
            ------
            NetworkRequestError -> If the request for fetching failed
        """
 
        headers = networkManager._headers()
        headers["node-access-token"] = accessToken
 
        response = networkManager.request("secret/node", RequestType.get, headers, {
            "name": name
        })
 
        if response.hasFailed():
            raise NetworkRequestError(response, f"Failed to fetch Node Secret \"{name}\"")
 
        return cls.decode(response.getJson(dict))

refresh()

bool coretex.entities.secret.secret.Secret.refresh	(		self,
		Optional[Dict[str, Any]]	jsonObject = None
	)

    Secret does not support this method

Definition at line 82 of file secret.py.

    def refresh(self, jsonObject: Optional[Dict[str, Any]] = None) -> bool:
        """
            Secret does not support this method
        """
 
        return NotImplemented
 

update()

bool coretex.entities.secret.secret.Secret.update	(		self,
		**Any	kwargs
	)

    Secret does not support this method

Definition at line 89 of file secret.py.

    def update(self, **kwargs: Any) -> bool:
        """
            Secret does not support this method
        """
 
        return NotImplemented
 

---

The documentation for this class was generated from the following file:

• coretex/entities/secret/secret.py