|
| 1 | +<!doctype html> |
| 2 | +<html lang="en"> |
| 3 | +<head> |
| 4 | +<meta charset="utf-8"> |
| 5 | +<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" /> |
| 6 | +<meta name="generator" content="pdoc 0.9.2" /> |
| 7 | +<title>webhooks.parser API documentation</title> |
| 8 | +<meta name="description" content="Webhooks parser module." /> |
| 9 | +<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin> |
| 10 | +<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin> |
| 11 | +<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin> |
| 12 | +<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;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:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 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 .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#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-weight:bold;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}.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 .5em;margin-bottom:1em}.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> |
| 13 | +<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}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style> |
| 14 | +<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> |
| 15 | +<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script> |
| 16 | +<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script> |
| 17 | +</head> |
| 18 | +<body> |
| 19 | +<main> |
| 20 | +<article id="content"> |
| 21 | +<header> |
| 22 | +<h1 class="title">Module <code>webhooks.parser</code></h1> |
| 23 | +</header> |
| 24 | +<section id="section-intro"> |
| 25 | +<p>Webhooks parser module.</p> |
| 26 | +<details class="source"> |
| 27 | +<summary> |
| 28 | +<span>Expand source code</span> |
| 29 | +</summary> |
| 30 | +<pre><code class="python">''' Webhooks parser module. ''' |
| 31 | + |
| 32 | +from typing import Union |
| 33 | + |
| 34 | +from livechat.config import CONFIG |
| 35 | +from livechat.webhooks.v33 import WebhookV33 |
| 36 | +from livechat.webhooks.v34 import WebhookV34 |
| 37 | +from livechat.webhooks.v35 import WebhookV35 |
| 38 | + |
| 39 | +stable_version = CONFIG.get('stable') |
| 40 | + |
| 41 | + |
| 42 | +def parse_webhook( |
| 43 | + wh_body: dict, |
| 44 | + version: str = stable_version, |
| 45 | +) -> Union[WebhookV33, WebhookV34, WebhookV35]: |
| 46 | + ''' Parses provided `wh_body` to a `Webhook` data class. |
| 47 | + |
| 48 | + Args: |
| 49 | + wh_body (dict): Webhook body received from LiveChat API. |
| 50 | + version (str): API's version. Defaults to the stable version of API. |
| 51 | + |
| 52 | + Returns: |
| 53 | + Webhook: data class with fields parsed from `wh_body`. |
| 54 | + |
| 55 | + Raises: |
| 56 | + ValueError: If provided `wh_body` is invalid (contains additional, |
| 57 | + invalid or missing fields). |
| 58 | + ''' |
| 59 | + webhook_data_class = { |
| 60 | + '3.3': WebhookV33, |
| 61 | + '3.4': WebhookV34, |
| 62 | + '3.5': WebhookV35, |
| 63 | + }.get(version) |
| 64 | + try: |
| 65 | + parsed_wh = webhook_data_class(**wh_body) |
| 66 | + except TypeError as error: |
| 67 | + raise ValueError( |
| 68 | + 'Invalid webhook body. It should contain the following fields: ' |
| 69 | + f'{webhook_data_class.__annotations__}') from error |
| 70 | + try: |
| 71 | + parsed_wh.payload = parsed_wh.payload_data_class()(**parsed_wh.payload) |
| 72 | + except KeyError as error: |
| 73 | + raise ValueError( |
| 74 | + f'`{parsed_wh.action}` is invalid webhook action. ' |
| 75 | + 'Check the correctness of the webhook body provided.') from error |
| 76 | + except TypeError as error: |
| 77 | + raise ValueError( |
| 78 | + 'Invalid webhook payload. It should contain the following fields: ' |
| 79 | + f'{parsed_wh.payload_data_class().__annotations__}') from error |
| 80 | + return parsed_wh</code></pre> |
| 81 | +</details> |
| 82 | +</section> |
| 83 | +<section> |
| 84 | +</section> |
| 85 | +<section> |
| 86 | +</section> |
| 87 | +<section> |
| 88 | +<h2 class="section-title" id="header-functions">Functions</h2> |
| 89 | +<dl> |
| 90 | +<dt id="webhooks.parser.parse_webhook"><code class="name flex"> |
| 91 | +<span>def <span class="ident">parse_webhook</span></span>(<span>wh_body: dict, version: str = '3.4') ‑> Union[livechat.webhooks.v33.WebhookV33, livechat.webhooks.v34.WebhookV34, livechat.webhooks.v35.WebhookV35]</span> |
| 92 | +</code></dt> |
| 93 | +<dd> |
| 94 | +<div class="desc"><p>Parses provided <code>wh_body</code> to a <code>Webhook</code> data class.</p> |
| 95 | +<h2 id="args">Args</h2> |
| 96 | +<dl> |
| 97 | +<dt><strong><code>wh_body</code></strong> : <code>dict</code></dt> |
| 98 | +<dd>Webhook body received from LiveChat API.</dd> |
| 99 | +<dt><strong><code>version</code></strong> : <code>str</code></dt> |
| 100 | +<dd>API's version. Defaults to the stable version of API.</dd> |
| 101 | +</dl> |
| 102 | +<h2 id="returns">Returns</h2> |
| 103 | +<dl> |
| 104 | +<dt><code>Webhook</code></dt> |
| 105 | +<dd>data class with fields parsed from <code>wh_body</code>.</dd> |
| 106 | +</dl> |
| 107 | +<h2 id="raises">Raises</h2> |
| 108 | +<dl> |
| 109 | +<dt><code>ValueError</code></dt> |
| 110 | +<dd>If provided <code>wh_body</code> is invalid (contains additional, |
| 111 | +invalid or missing fields).</dd> |
| 112 | +</dl></div> |
| 113 | +<details class="source"> |
| 114 | +<summary> |
| 115 | +<span>Expand source code</span> |
| 116 | +</summary> |
| 117 | +<pre><code class="python">def parse_webhook( |
| 118 | + wh_body: dict, |
| 119 | + version: str = stable_version, |
| 120 | +) -> Union[WebhookV33, WebhookV34, WebhookV35]: |
| 121 | + ''' Parses provided `wh_body` to a `Webhook` data class. |
| 122 | + |
| 123 | + Args: |
| 124 | + wh_body (dict): Webhook body received from LiveChat API. |
| 125 | + version (str): API's version. Defaults to the stable version of API. |
| 126 | + |
| 127 | + Returns: |
| 128 | + Webhook: data class with fields parsed from `wh_body`. |
| 129 | + |
| 130 | + Raises: |
| 131 | + ValueError: If provided `wh_body` is invalid (contains additional, |
| 132 | + invalid or missing fields). |
| 133 | + ''' |
| 134 | + webhook_data_class = { |
| 135 | + '3.3': WebhookV33, |
| 136 | + '3.4': WebhookV34, |
| 137 | + '3.5': WebhookV35, |
| 138 | + }.get(version) |
| 139 | + try: |
| 140 | + parsed_wh = webhook_data_class(**wh_body) |
| 141 | + except TypeError as error: |
| 142 | + raise ValueError( |
| 143 | + 'Invalid webhook body. It should contain the following fields: ' |
| 144 | + f'{webhook_data_class.__annotations__}') from error |
| 145 | + try: |
| 146 | + parsed_wh.payload = parsed_wh.payload_data_class()(**parsed_wh.payload) |
| 147 | + except KeyError as error: |
| 148 | + raise ValueError( |
| 149 | + f'`{parsed_wh.action}` is invalid webhook action. ' |
| 150 | + 'Check the correctness of the webhook body provided.') from error |
| 151 | + except TypeError as error: |
| 152 | + raise ValueError( |
| 153 | + 'Invalid webhook payload. It should contain the following fields: ' |
| 154 | + f'{parsed_wh.payload_data_class().__annotations__}') from error |
| 155 | + return parsed_wh</code></pre> |
| 156 | +</details> |
| 157 | +</dd> |
| 158 | +</dl> |
| 159 | +</section> |
| 160 | +<section> |
| 161 | +</section> |
| 162 | +</article> |
| 163 | +<nav id="sidebar"> |
| 164 | +<h1>Index</h1> |
| 165 | +<div class="toc"> |
| 166 | +<ul></ul> |
| 167 | +</div> |
| 168 | +<ul id="index"> |
| 169 | +<li><h3>Super-module</h3> |
| 170 | +<ul> |
| 171 | +<li><code><a title="webhooks" href="index.html">webhooks</a></code></li> |
| 172 | +</ul> |
| 173 | +</li> |
| 174 | +<li><h3><a href="#header-functions">Functions</a></h3> |
| 175 | +<ul class=""> |
| 176 | +<li><code><a title="webhooks.parser.parse_webhook" href="#webhooks.parser.parse_webhook">parse_webhook</a></code></li> |
| 177 | +</ul> |
| 178 | +</li> |
| 179 | +</ul> |
| 180 | +</nav> |
| 181 | +</main> |
| 182 | +<footer id="footer"> |
| 183 | +<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p> |
| 184 | +</footer> |
| 185 | +</body> |
| 186 | +</html> |
0 commit comments