server-client-python/tableauserverclient/server/endpoint/extensions_endpoint.py at 2cb20432344792bd17432937a1b887c50ff282ad · tableau/server-client-python · GitHub

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
from tableauserverclient.models.extensions_item import ExtensionsServer, ExtensionsSiteSettings
from tableauserverclient.server.endpoint.endpoint import Endpoint
from tableauserverclient.server.endpoint.endpoint import api
from tableauserverclient.server.request_factory import RequestFactory


class Extensions(Endpoint):
    def __init__(self, parent_srv):
        super().__init__(parent_srv)

    @property
    def _server_baseurl(self) -> str:
        return f"{self.parent_srv.baseurl}/settings/extensions"

    @property
    def baseurl(self) -> str:
        return f"{self.parent_srv.baseurl}/sites/{self.parent_srv.site_id}/settings/extensions"

    @api(version="3.21")
    def get_server_settings(self) -> ExtensionsServer:
        """Lists the settings for extensions of a server

        Returns
        -------
        ExtensionsServer
            The server extensions settings
        """
        response = self.get_request(self._server_baseurl)
        return ExtensionsServer.from_response(response.content, self.parent_srv.namespace)

    @api(version="3.21")
    def update_server_settings(self, extensions_server: ExtensionsServer) -> ExtensionsServer:
        """Updates the settings for extensions of a server. Overwrites all existing settings. Any
        sites omitted from the block list will be unblocked.

        Parameters
        ----------
        extensions_server : ExtensionsServer
            The server extensions settings to update

        Returns
        -------
        ExtensionsServer
            The updated server extensions settings
        """
        req = RequestFactory.Extensions.update_server_extensions(extensions_server)
        response = self.put_request(self._server_baseurl, req)
        return ExtensionsServer.from_response(response.content, self.parent_srv.namespace)

    @api(version="3.21")
    def get(self) -> ExtensionsSiteSettings:
        """Lists the extensions settings for the site

        Returns
        -------
        ExtensionsSiteSettings
            The site extensions settings
        """
        response = self.get_request(self.baseurl)
        return ExtensionsSiteSettings.from_response(response.content, self.parent_srv.namespace)

    @api(version="3.21")
    def update(self, extensions_site_settings: ExtensionsSiteSettings) -> ExtensionsSiteSettings:
        """Updates the extensions settings for the site. Any extensions omitted
        from the safe extensions list will be removed.

        Parameters
        ----------
        extensions_site_settings : ExtensionsSiteSettings
            The site extensions settings to update

        Returns
        -------
        ExtensionsSiteSettings
            The updated site extensions settings
        """
        req = RequestFactory.Extensions.update_site_extensions(extensions_site_settings)
        response = self.put_request(self.baseurl, req)
        return ExtensionsSiteSettings.from_response(response.content, self.parent_srv.namespace)