Updated docs and version

This commit is contained in:
2025-11-07 13:13:10 +03:00
parent 68921de31f
commit d53c05df19
17 changed files with 534 additions and 8 deletions

View File

@@ -55,10 +55,12 @@
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.company_is_foreign_agent"><code class="docutils literal notranslate"><span class="pre">company_is_foreign_agent()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.search_global_company_profiles_id"><code class="docutils literal notranslate"><span class="pre">search_global_company_profiles_id()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.legal_entity_profile_report"><code class="docutils literal notranslate"><span class="pre">legal_entity_profile_report()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.full_company_report"><code class="docutils literal notranslate"><span class="pre">full_company_report()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id6">Физические лица</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.person_is_foreign_agent"><code class="docutils literal notranslate"><span class="pre">person_is_foreign_agent()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.full_individual_report"><code class="docutils literal notranslate"><span class="pre">full_individual_report()</span></code></a></li>
</ul>
</li>
</ul>
@@ -135,11 +137,14 @@
<span class="sig-name descname"><span class="pre">search_global_company_profiles_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.FocusCompliance.search_global_company_profiles_id" title="Ссылка на это определение"></a></dt>
<dd><p>Поиск сводной информации по санкционным профилям ЮЛ</p>
<dl class="field-list simple">
<dt class="field-odd">Результат<span class="colon">:</span></dt>
<dd class="field-odd"><p>Список идентификаторов профилей</p>
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>company_name</strong> (<em>str</em>) Наименование компании</p>
</dd>
<dt class="field-even">Тип результата<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
<dt class="field-even">Результат<span class="colon">:</span></dt>
<dd class="field-even"><p>Список идентификаторов профилей</p>
</dd>
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
@@ -164,6 +169,28 @@
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="kontur_focus.FocusCompliance.full_company_report">
<span class="sig-name descname"><span class="pre">full_company_report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.FocusCompliance.full_company_report" title="Ссылка на это определение"></a></dt>
<dd><p>Запрос на полную проверку и построение печатного отчёта по организации</p>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>model</strong> (<em>str</em><em>, </em><em>optional</em>) Идентификатор модели, по которой пройдет проверка.
Идентификатор возвращается в методе «Получение списка рисковых моделей организации»
GET /banks/{bankId}/models, defaults to „115-fz“</p></li>
<li><p><strong>path</strong> (<em>str</em><em>, </em><em>optional</em>) Путь сохранения файла, по-умолчанию файл сохраняется в текущий каталог, defaults to None</p></li>
</ul>
</dd>
<dt class="field-even">Результат<span class="colon">:</span></dt>
<dd class="field-even"><p>Отчет о результате сохранения файла</p>
</dd>
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
</dd></dl>
<p>Пример вывода результат по отчету:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[{</span><span class="s1">&#39;success&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">&#39;filename&#39;</span><span class="p">:</span> <span class="s1">&#39;&lt;имя_файла&gt;&#39;</span><span class="p">,</span> <span class="s1">&#39;path&#39;</span><span class="p">:</span> <span class="s1">&#39;&lt;полный_путь_файла&gt;&#39;</span><span class="p">}]</span>
</pre></div>
@@ -185,6 +212,30 @@
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="kontur_focus.FocusCompliance.full_individual_report">
<span class="sig-name descname"><span class="pre">full_individual_report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">passport</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fio</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.FocusCompliance.full_individual_report" title="Ссылка на это определение"></a></dt>
<dd><dl class="simple">
<dt>Запрос на построение печатного отчёта по физ лицу</dt><dd><p>Необходимо обязательно указать либо ИНН, либо ФИО и номер паспорта</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>path</strong> (<em>str</em><em>, </em><em>optional</em>) Путь сохранения файла, по-умолчанию файл сохраняется в текущий каталог, defaults to None</p></li>
<li><p><strong>passport</strong> (<em>str</em><em>, </em><em>optional</em>) Номер паспорты, defaults to None</p></li>
<li><p><strong>fio</strong> (<em>str</em><em>, </em><em>optional</em>) ФИО (хотя бы фамилия и имя), defaults to None</p></li>
</ul>
</dd>
<dt class="field-even">Результат<span class="colon">:</span></dt>
<dd class="field-even"><p>Отчет о результате сохранения файла</p>
</dd>
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
</dd></dl>
</section>
</section>