File: account.html

package info (click to toggle)
pycontrol4 2.0.2-1
links: PTS, VCS
area: main
in suites: forky, sid
size: 656 kB
sloc: python: 1,438; makefile: 3
file content (584 lines) | stat: -rw-r--r-- 29,692 bytes
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.6">
<title>pyControl4.account API documentation</title>
<meta name="description" content="Authenticates with the Control4 API, retrieves account and registered
controller info, and retrieves a bearer token for connecting to a Control4 …">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>pyControl4.account</code></h1>
</header>
<section id="section-intro">
<p>Authenticates with the Control4 API, retrieves account and registered
controller info, and retrieves a bearer token for connecting to a Control4 Director.</p>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="pyControl4.account.C4Account"><code class="flex name class">
<span>class <span class="ident">C4Account</span></span>
<span>(</span><span>username: str, password: str, session: aiohttp.ClientSession | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class C4Account:
    def __init__(
        self,
        username: str,
        password: str,
        session: aiohttp.ClientSession | None = None,
    ):
        &#34;&#34;&#34;Creates a Control4 account object.

        Parameters:
            `username` - Control4 account username/email.

            `password` - Control4 account password.

            `session` - (Optional) Allows the use of an `aiohttp.ClientSession`
                object for all network requests. This session will not be closed
                by the library. If not provided, the library will open and close
                its own `ClientSession`s as needed.
        &#34;&#34;&#34;
        self.username = username
        self.password = password
        self.session = session

    @asynccontextmanager
    async def _get_session(self) -&gt; AsyncGenerator[aiohttp.ClientSession, None]:
        &#34;&#34;&#34;Returns the configured session or creates a temporary one.

        If self.session is set, yields it without closing.
        Otherwise, creates and closes a temporary session.
        &#34;&#34;&#34;
        if self.session is not None:
            yield self.session
        else:
            async with aiohttp.ClientSession() as session:
                yield session

    async def _send_account_auth_request(self) -&gt; str:
        &#34;&#34;&#34;Used internally to retrieve an account bearer token. Returns the entire
        JSON response from the Control4 auth API.
        &#34;&#34;&#34;
        data_dict = {
            &#34;clientInfo&#34;: {
                &#34;device&#34;: {
                    &#34;deviceName&#34;: &#34;pyControl4&#34;,
                    &#34;deviceUUID&#34;: &#34;0000000000000000&#34;,
                    &#34;make&#34;: &#34;pyControl4&#34;,
                    &#34;model&#34;: &#34;pyControl4&#34;,
                    &#34;os&#34;: &#34;Android&#34;,
                    &#34;osVersion&#34;: &#34;10&#34;,
                },
                &#34;userInfo&#34;: {
                    &#34;applicationKey&#34;: APPLICATION_KEY,
                    &#34;password&#34;: self.password,
                    &#34;userName&#34;: self.username,
                },
            }
        }
        async with self._get_session() as session:
            async with asyncio.timeout(10):
                async with session.post(
                    AUTHENTICATION_ENDPOINT, json=data_dict
                ) as resp:
                    text = await resp.text()
                    check_response_for_error(text)
                    return text

    async def _send_account_get_request(self, uri: str) -&gt; str:
        &#34;&#34;&#34;Used internally to send GET requests to the Control4 API,
        authenticated with the account bearer token. Returns the entire JSON
        response from the Control4 auth API.

        Parameters:
            `uri` - Full URI to send GET request to.
        &#34;&#34;&#34;
        try:
            headers = {&#34;Authorization&#34;: f&#34;Bearer {self.account_bearer_token}&#34;}
        except AttributeError:
            msg = (
                &#34;The account bearer token is missing. &#34;
                &#34;Is your username/password correct?&#34;
            )
            _LOGGER.error(msg)
            raise
        async with self._get_session() as session:
            async with asyncio.timeout(10):
                async with session.get(uri, headers=headers) as resp:
                    text = await resp.text()
                    check_response_for_error(text)
                    return text

    async def _send_controller_auth_request(self, controller_common_name: str) -&gt; str:
        &#34;&#34;&#34;Used internally to retrieve an director bearer token. Returns the
        entire JSON response from the Control4 auth API.

        Parameters:
            `controller_common_name`: Common name of the controller.
                See `get_account_controllers()` for details.
        &#34;&#34;&#34;
        try:
            headers = {&#34;Authorization&#34;: f&#34;Bearer {self.account_bearer_token}&#34;}
        except AttributeError:
            msg = (
                &#34;The account bearer token is missing. &#34;
                &#34;Is your username/password correct?&#34;
            )
            _LOGGER.error(msg)
            raise
        data_dict = {
            &#34;serviceInfo&#34;: {
                &#34;commonName&#34;: controller_common_name,
                &#34;services&#34;: &#34;director&#34;,
            }
        }
        async with self._get_session() as session:
            async with asyncio.timeout(10):
                async with session.post(
                    CONTROLLER_AUTHORIZATION_ENDPOINT,
                    headers=headers,
                    json=data_dict,
                ) as resp:
                    text = await resp.text()
                    check_response_for_error(text)
                    return text

    async def get_account_bearer_token(self) -&gt; str:
        &#34;&#34;&#34;Gets an account bearer token for making Control4 online API requests.&#34;&#34;&#34;
        data = await self._send_account_auth_request()
        json_dict = json.loads(data)
        try:
            token: str = json_dict[&#34;authToken&#34;][&#34;token&#34;]
            self.account_bearer_token = token
            return token
        except KeyError:
            msg = (
                &#34;Did not receive an account bearer token. &#34;
                &#34;Is your username/password correct?&#34;
            )
            _LOGGER.error(msg + data)
            raise

    async def get_account_controllers(self) -&gt; dict[str, Any]:
        &#34;&#34;&#34;Returns a dictionary of the information for all controllers registered
        to an account.

        Returns:
            ```
            {
                &#34;controllerCommonName&#34;: &#34;control4_MODEL_MACADDRESS&#34;,
                &#34;href&#34;: &#34;https://apis.control4.com/account/v3/rest/accounts/000000&#34;,
                &#34;name&#34;: &#34;Name&#34;
            }
            ```
        &#34;&#34;&#34;
        data = await self._send_account_get_request(GET_CONTROLLERS_ENDPOINT)
        json_dict = json.loads(data)
        try:
            result: dict[str, Any] = json_dict[&#34;account&#34;]
            return result
        except KeyError:
            msg = &#34;Did not receive account information from the Control4 API.&#34;
            _LOGGER.error(msg + &#34; Response: &#34; + data)
            raise

    async def get_controller_info(self, controller_href: str) -&gt; dict[str, Any]:
        &#34;&#34;&#34;Returns a dictionary of the information of a specific controller.

        Parameters:
            `controller_href` - The API `href` of the controller (get this from
                the output of `get_account_controllers()`)

        Returns:
            ```
            {
                &#39;allowsPatching&#39;: True,
                &#39;allowsSupport&#39;: False,
                &#39;blockNotifications&#39;: False,
                &#39;controllerCommonName&#39;: &#39;control4_MODEL_MACADDRESS&#39;,
                &#39;controller&#39;: {
                    &#39;href&#39;: &#39;https://apis.control4.com/account/v3/rest/accounts/000000/controller&#39;  # noqa: E501
                },
                &#39;created&#39;: &#39;2017-08-26T18:33:31Z&#39;,
                &#39;dealer&#39;: {
                    &#39;href&#39;: &#39;https://apis.control4.com/account/v3/rest/dealers/12345&#39;
                },
                &#39;enabled&#39;: True,
                &#39;hasLoggedIn&#39;: True,
                &#39;href&#39;: &#39;https://apis.control4.com/account/v3/rest/accounts/000000&#39;,
                &#39;id&#39;: 000000,
                &#39;lastCheckIn&#39;: &#39;2020-06-13T21:52:34Z&#39;,
                &#39;licenses&#39;: {
                    &#39;href&#39;: &#39;https://apis.control4.com/account/v3/rest/accounts/000000/licenses&#39;  # noqa: E501
                },
                &#39;modified&#39;: &#39;2020-06-13T21:52:34Z&#39;,
                &#39;name&#39;: &#39;Name&#39;,
                &#39;provisionDate&#39;: &#39;2017-08-26T18:35:11Z&#39;,
                &#39;storage&#39;: {
                    &#39;href&#39;: &#39;https://apis.control4.com/storage/v1/rest/accounts/000000&#39;
                },
                &#39;type&#39;: &#39;Consumer&#39;,
                &#39;users&#39;: {
                    &#39;href&#39;: &#39;https://apis.control4.com/account/v3/rest/accounts/000000/users&#39;  # noqa: E501
                }
            }
            ```
        &#34;&#34;&#34;
        data = await self._send_account_get_request(controller_href)
        json_dict: dict[str, Any] = json.loads(data)
        return json_dict

    async def get_controller_os_version(self, controller_href: str) -&gt; str:
        &#34;&#34;&#34;Returns the OS version of a controller as a string.

        Parameters:
            `controller_href` - The API `href` of the controller (get this from
                the output of `get_account_controllers()`)
        &#34;&#34;&#34;
        data = await self._send_account_get_request(controller_href + &#34;/controller&#34;)
        json_dict = json.loads(data)
        try:
            version: str = json_dict[&#34;osVersion&#34;]
            return version
        except KeyError:
            msg = &#34;Did not receive OS version from the Control4 API.&#34;
            _LOGGER.error(msg + &#34; Response: &#34; + data)
            raise

    async def get_director_bearer_token(
        self, controller_common_name: str
    ) -&gt; dict[str, Any]:
        &#34;&#34;&#34;Returns a dictionary with a director bearer token for making Control4
        Director API requests, and its time valid in seconds (usually 86400 seconds)

        Parameters:
            `controller_common_name`: Common name of the controller.
                See `get_account_controllers()` for details.
        &#34;&#34;&#34;
        data = await self._send_controller_auth_request(controller_common_name)
        json_dict = json.loads(data)
        try:
            auth_token = json_dict.get(&#34;authToken&#34;, {})
            token = auth_token.get(&#34;token&#34;)
            valid_seconds = auth_token.get(&#34;validSeconds&#34;)
            if token is None or valid_seconds is None:
                raise KeyError(&#34;Missing token or validSeconds in authToken&#34;)
            return {&#34;token&#34;: token, &#34;validSeconds&#34;: valid_seconds}
        except KeyError:
            msg = &#34;Did not receive a director bearer token from the Control4 API.&#34;
            _LOGGER.error(msg + &#34; Response: &#34; + data)
            raise</code></pre>
</details>
<div class="desc"><p>Creates a Control4 account object.</p>
<h2 id="parameters">Parameters</h2>
<p><code>username</code> - Control4 account username/email.</p>
<p><code>password</code> - Control4 account password.</p>
<p><code>session</code> - (Optional) Allows the use of an <code>aiohttp.ClientSession</code>
object for all network requests. This session will not be closed
by the library. If not provided, the library will open and close
its own <code>ClientSession</code>s as needed.</p></div>
<h3>Methods</h3>
<dl>
<dt id="pyControl4.account.C4Account.get_account_bearer_token"><code class="name flex">
<span>async def <span class="ident">get_account_bearer_token</span></span>(<span>self) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_account_bearer_token(self) -&gt; str:
    &#34;&#34;&#34;Gets an account bearer token for making Control4 online API requests.&#34;&#34;&#34;
    data = await self._send_account_auth_request()
    json_dict = json.loads(data)
    try:
        token: str = json_dict[&#34;authToken&#34;][&#34;token&#34;]
        self.account_bearer_token = token
        return token
    except KeyError:
        msg = (
            &#34;Did not receive an account bearer token. &#34;
            &#34;Is your username/password correct?&#34;
        )
        _LOGGER.error(msg + data)
        raise</code></pre>
</details>
<div class="desc"><p>Gets an account bearer token for making Control4 online API requests.</p></div>
</dd>
<dt id="pyControl4.account.C4Account.get_account_controllers"><code class="name flex">
<span>async def <span class="ident">get_account_controllers</span></span>(<span>self) ‑> dict[str, typing.Any]</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_account_controllers(self) -&gt; dict[str, Any]:
    &#34;&#34;&#34;Returns a dictionary of the information for all controllers registered
    to an account.

    Returns:
        ```
        {
            &#34;controllerCommonName&#34;: &#34;control4_MODEL_MACADDRESS&#34;,
            &#34;href&#34;: &#34;https://apis.control4.com/account/v3/rest/accounts/000000&#34;,
            &#34;name&#34;: &#34;Name&#34;
        }
        ```
    &#34;&#34;&#34;
    data = await self._send_account_get_request(GET_CONTROLLERS_ENDPOINT)
    json_dict = json.loads(data)
    try:
        result: dict[str, Any] = json_dict[&#34;account&#34;]
        return result
    except KeyError:
        msg = &#34;Did not receive account information from the Control4 API.&#34;
        _LOGGER.error(msg + &#34; Response: &#34; + data)
        raise</code></pre>
</details>
<div class="desc"><p>Returns a dictionary of the information for all controllers registered
to an account.</p>
<h2 id="returns">Returns</h2>
<pre><code>{
    &quot;controllerCommonName&quot;: &quot;control4_MODEL_MACADDRESS&quot;,
    &quot;href&quot;: &quot;https://apis.control4.com/account/v3/rest/accounts/000000&quot;,
    &quot;name&quot;: &quot;Name&quot;
}
</code></pre></div>
</dd>
<dt id="pyControl4.account.C4Account.get_controller_info"><code class="name flex">
<span>async def <span class="ident">get_controller_info</span></span>(<span>self, controller_href: str) ‑> dict[str, typing.Any]</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_controller_info(self, controller_href: str) -&gt; dict[str, Any]:
    &#34;&#34;&#34;Returns a dictionary of the information of a specific controller.

    Parameters:
        `controller_href` - The API `href` of the controller (get this from
            the output of `get_account_controllers()`)

    Returns:
        ```
        {
            &#39;allowsPatching&#39;: True,
            &#39;allowsSupport&#39;: False,
            &#39;blockNotifications&#39;: False,
            &#39;controllerCommonName&#39;: &#39;control4_MODEL_MACADDRESS&#39;,
            &#39;controller&#39;: {
                &#39;href&#39;: &#39;https://apis.control4.com/account/v3/rest/accounts/000000/controller&#39;  # noqa: E501
            },
            &#39;created&#39;: &#39;2017-08-26T18:33:31Z&#39;,
            &#39;dealer&#39;: {
                &#39;href&#39;: &#39;https://apis.control4.com/account/v3/rest/dealers/12345&#39;
            },
            &#39;enabled&#39;: True,
            &#39;hasLoggedIn&#39;: True,
            &#39;href&#39;: &#39;https://apis.control4.com/account/v3/rest/accounts/000000&#39;,
            &#39;id&#39;: 000000,
            &#39;lastCheckIn&#39;: &#39;2020-06-13T21:52:34Z&#39;,
            &#39;licenses&#39;: {
                &#39;href&#39;: &#39;https://apis.control4.com/account/v3/rest/accounts/000000/licenses&#39;  # noqa: E501
            },
            &#39;modified&#39;: &#39;2020-06-13T21:52:34Z&#39;,
            &#39;name&#39;: &#39;Name&#39;,
            &#39;provisionDate&#39;: &#39;2017-08-26T18:35:11Z&#39;,
            &#39;storage&#39;: {
                &#39;href&#39;: &#39;https://apis.control4.com/storage/v1/rest/accounts/000000&#39;
            },
            &#39;type&#39;: &#39;Consumer&#39;,
            &#39;users&#39;: {
                &#39;href&#39;: &#39;https://apis.control4.com/account/v3/rest/accounts/000000/users&#39;  # noqa: E501
            }
        }
        ```
    &#34;&#34;&#34;
    data = await self._send_account_get_request(controller_href)
    json_dict: dict[str, Any] = json.loads(data)
    return json_dict</code></pre>
</details>
<div class="desc"><p>Returns a dictionary of the information of a specific controller.</p>
<h2 id="parameters">Parameters</h2>
<p><code>controller_href</code> - The API <code>href</code> of the controller (get this from
the output of <code>get_account_controllers()</code>)</p>
<h2 id="returns">Returns</h2>
<pre><code>{
    'allowsPatching': True,
    'allowsSupport': False,
    'blockNotifications': False,
    'controllerCommonName': 'control4_MODEL_MACADDRESS',
    'controller': {
        'href': 'https://apis.control4.com/account/v3/rest/accounts/000000/controller'  # noqa: E501
    },
    'created': '2017-08-26T18:33:31Z',
    'dealer': {
        'href': 'https://apis.control4.com/account/v3/rest/dealers/12345'
    },
    'enabled': True,
    'hasLoggedIn': True,
    'href': 'https://apis.control4.com/account/v3/rest/accounts/000000',
    'id': 000000,
    'lastCheckIn': '2020-06-13T21:52:34Z',
    'licenses': {
        'href': 'https://apis.control4.com/account/v3/rest/accounts/000000/licenses'  # noqa: E501
    },
    'modified': '2020-06-13T21:52:34Z',
    'name': 'Name',
    'provisionDate': '2017-08-26T18:35:11Z',
    'storage': {
        'href': 'https://apis.control4.com/storage/v1/rest/accounts/000000'
    },
    'type': 'Consumer',
    'users': {
        'href': 'https://apis.control4.com/account/v3/rest/accounts/000000/users'  # noqa: E501
    }
}
</code></pre></div>
</dd>
<dt id="pyControl4.account.C4Account.get_controller_os_version"><code class="name flex">
<span>async def <span class="ident">get_controller_os_version</span></span>(<span>self, controller_href: str) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_controller_os_version(self, controller_href: str) -&gt; str:
    &#34;&#34;&#34;Returns the OS version of a controller as a string.

    Parameters:
        `controller_href` - The API `href` of the controller (get this from
            the output of `get_account_controllers()`)
    &#34;&#34;&#34;
    data = await self._send_account_get_request(controller_href + &#34;/controller&#34;)
    json_dict = json.loads(data)
    try:
        version: str = json_dict[&#34;osVersion&#34;]
        return version
    except KeyError:
        msg = &#34;Did not receive OS version from the Control4 API.&#34;
        _LOGGER.error(msg + &#34; Response: &#34; + data)
        raise</code></pre>
</details>
<div class="desc"><p>Returns the OS version of a controller as a string.</p>
<h2 id="parameters">Parameters</h2>
<p><code>controller_href</code> - The API <code>href</code> of the controller (get this from
the output of <code>get_account_controllers()</code>)</p></div>
</dd>
<dt id="pyControl4.account.C4Account.get_director_bearer_token"><code class="name flex">
<span>async def <span class="ident">get_director_bearer_token</span></span>(<span>self, controller_common_name: str) ‑> dict[str, typing.Any]</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_director_bearer_token(
    self, controller_common_name: str
) -&gt; dict[str, Any]:
    &#34;&#34;&#34;Returns a dictionary with a director bearer token for making Control4
    Director API requests, and its time valid in seconds (usually 86400 seconds)

    Parameters:
        `controller_common_name`: Common name of the controller.
            See `get_account_controllers()` for details.
    &#34;&#34;&#34;
    data = await self._send_controller_auth_request(controller_common_name)
    json_dict = json.loads(data)
    try:
        auth_token = json_dict.get(&#34;authToken&#34;, {})
        token = auth_token.get(&#34;token&#34;)
        valid_seconds = auth_token.get(&#34;validSeconds&#34;)
        if token is None or valid_seconds is None:
            raise KeyError(&#34;Missing token or validSeconds in authToken&#34;)
        return {&#34;token&#34;: token, &#34;validSeconds&#34;: valid_seconds}
    except KeyError:
        msg = &#34;Did not receive a director bearer token from the Control4 API.&#34;
        _LOGGER.error(msg + &#34; Response: &#34; + data)
        raise</code></pre>
</details>
<div class="desc"><p>Returns a dictionary with a director bearer token for making Control4
Director API requests, and its time valid in seconds (usually 86400 seconds)</p>
<h2 id="parameters">Parameters</h2>
<p><code>controller_common_name</code>: Common name of the controller.
See <code>get_account_controllers()</code> for details.</p></div>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="pyControl4" href="index.html">pyControl4</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="pyControl4.account.C4Account" href="#pyControl4.account.C4Account">C4Account</a></code></h4>
<ul class="">
<li><code><a title="pyControl4.account.C4Account.get_account_bearer_token" href="#pyControl4.account.C4Account.get_account_bearer_token">get_account_bearer_token</a></code></li>
<li><code><a title="pyControl4.account.C4Account.get_account_controllers" href="#pyControl4.account.C4Account.get_account_controllers">get_account_controllers</a></code></li>
<li><code><a title="pyControl4.account.C4Account.get_controller_info" href="#pyControl4.account.C4Account.get_controller_info">get_controller_info</a></code></li>
<li><code><a title="pyControl4.account.C4Account.get_controller_os_version" href="#pyControl4.account.C4Account.get_controller_os_version">get_controller_os_version</a></code></li>
<li><code><a title="pyControl4.account.C4Account.get_director_bearer_token" href="#pyControl4.account.C4Account.get_director_bearer_token">get_director_bearer_token</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
</footer>
</body>
</html>