--- /dev/null
+<?xml version='1.0' encoding='UTF-8'?>
+<chapter xmlns="http://docbook.org/ns/docbook">
+ <title>Управление тарифами</title>
+ <para>В этом разделе собраны вызовы для манипулирования тарифными планами. Тарифный план включает в себя:</para>
+ <itemizedlist>
+ <listitem><para>название;</para></listitem>
+ <listitem><para>абонплата;</para></listitem>
+ <listitem><para>количество бесплатных мегабайт, включенных в абонплату;</para></listitem>
+ <listitem><para>стоимость "заморозки" пользователя;</para></listitem>
+ <listitem>
+ <para>тип подсчета трафика:</para>
+ <itemizedlist>
+ <listitem><para>только входящий,</para></listitem>
+ <listitem><para>только исходящий,</para></listitem>
+ <listitem><para>входящий и исходящий суммарно,</para></listitem>
+ <listitem><para>максимум из входящего и исходящего</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>информацию о тарификации направлений:</para>
+ <itemizedlist>
+ <listitem><para>время начала дня;</para></listitem>
+ <listitem><para>конца дня;</para></listitem>
+ <listitem><para>цена за мегабайт трафика до порога днем;</para></listitem>
+ <listitem><para>цена за мегабайт трафика после порога днем;</para></listitem>
+ <listitem><para>цена за мегабайт трафика до порога ночью;</para></listitem>
+ <listitem><para>цена за мегабайт трафика после порога ночью;</para></listitem>
+ <listitem><para>пороговый объем трафика в мегабайтах;</para></listitem>
+ <listitem><para>флаг игнорирования времени суток;</para></listitem>
+ <listitem><para>флаг игнорирования порога.</para></listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ <refentry id="stargazer.get_tariff">
+ <refmeta>
+ <refentrytitle>stargazer.get_tariff</refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>stargazer.get_tariff</refname>
+ <refpurpose>Получает информацию о тарифном плане</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef><function>stargazer.get_tariff</function></funcdef>
+ <paramdef>string <parameter>cookie</parameter></paramdef>
+ <paramdef>string <parameter>tariff</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Метод <function>stargazer.get_tariff</function> получает информацию о тарифном плане.</para>
+ <variablelist>
+ <varlistentry>
+ <term>string <parameter>cookie</parameter></term>
+ <listitem>
+ <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>string <parameter>tariff</parameter></term>
+ <listitem>
+ <para>Название тарифа</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <refsect2>
+ <title>Return Value</title>
+ <para>
+ Возвращает структуру:
+ <variablelist>
+ <varlistentry>
+ <term>boolean <parameter>result</parameter></term>
+ <listitem>
+ <para>Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie, неправильное название тарифа).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>string <parameter>name</parameter></term>
+ <listitem>
+ <para>Название тарифа</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>fee</parameter></term>
+ <listitem>
+ <para>Абонплата</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>freemb</parameter></term>
+ <listitem>
+ <para>Количество бесплатных мегабайт включенных в абонплату</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>passivecost</parameter></term>
+ <listitem>
+ <para>Стоимость "заморозки" пользователя</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>trafftype</parameter></term>
+ <listitem>
+ <para>Тип подсчета трафика:
+ <simplelist type="vert">
+ <member>0 — подсчитывать только исходящий трафик</member>
+ <member>1 — подсчитывать только входящий трафик</member>
+ <member>2 — подсчитывать суммарно входящий и исходящий трафик</member>
+ <member>3 — подсчитывать максимальный из входящего и исходящего трафика</member>
+ </simplelist>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>array of struct <parameter>dirprices</parameter></term>
+ <listitem>
+ <para>Массив стурктур, описывающих тарификацию направлений:
+ <variablelist>
+ <varlistentry>
+ <term>int <parameter>hday</parameter></term>
+ <listitem>
+ <para>Часы начала дня</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>mday</parameter></term>
+ <listitem>
+ <para>Минуты начала дня</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>hnight</parameter></term>
+ <listitem>
+ <para>Часы начала ночи</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>mnight</parameter></term>
+ <listitem>
+ <para>Минуты начала ночи</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricedaya</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricedayb</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricenighta</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricenightb</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>threshold</parameter></term>
+ <listitem>
+ <para>Величина порога в мегабайтах</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>boolean <parameter>singleprice</parameter></term>
+ <listitem>
+ <para>Цена не зависит от времени суток</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>boolean <parameter>nodiscount</parameter></term>
+ <listitem>
+ <para>Цена не зависит от порога</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect2>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para>
+ <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
+ <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
+ <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
+ <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="stargazer.get_tariffs">
+ <refmeta>
+ <refentrytitle>stargazer.get_tariffs</refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>stargazer.get_tariffs</refname>
+ <refpurpose>Получает информацию о тарифных планах</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef><function>stargazer.get_tariffs</function></funcdef>
+ <paramdef>string <parameter>cookie</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Метод <function>stargazer.get_tariffs</function> получает информацию о тарифных планах.</para>
+ <variablelist>
+ <varlistentry>
+ <term>string <parameter>cookie</parameter></term>
+ <listitem>
+ <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <refsect2>
+ <title>Return Value</title>
+ <para>
+ Возвращает массив структур:
+ <variablelist>
+ <varlistentry>
+ <term>boolean <parameter>result</parameter></term>
+ <listitem>
+ <para>Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie, неправильное название тарифа).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>string <parameter>name</parameter></term>
+ <listitem>
+ <para>Название тарифа</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>fee</parameter></term>
+ <listitem>
+ <para>Абонплата</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>freemb</parameter></term>
+ <listitem>
+ <para>Количество бесплатных мегабайт включенных в абонплату</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>passivecost</parameter></term>
+ <listitem>
+ <para>Стоимость "заморозки" пользователя</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>trafftype</parameter></term>
+ <listitem>
+ <para>Тип подсчета трафика:
+ <simplelist type="vert">
+ <member>0 — подсчитывать только исходящий трафик</member>
+ <member>1 — подсчитывать только входящий трафик</member>
+ <member>2 — подсчитывать суммарно входящий и исходящий трафик</member>
+ <member>3 — подсчитывать максимальный из входящего и исходящего трафика</member>
+ </simplelist>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>array of struct <parameter>dirprices</parameter></term>
+ <listitem>
+ <para>Массив стурктур, описывающих тарификацию направлений:
+ <variablelist>
+ <varlistentry>
+ <term>int <parameter>hday</parameter></term>
+ <listitem>
+ <para>Часы начала дня</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>mday</parameter></term>
+ <listitem>
+ <para>Минуты начала дня</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>hnight</parameter></term>
+ <listitem>
+ <para>Часы начала ночи</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>mnight</parameter></term>
+ <listitem>
+ <para>Минуты начала ночи</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricedaya</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricedayb</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricenighta</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricenightb</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>threshold</parameter></term>
+ <listitem>
+ <para>Величина порога в мегабайтах</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>boolean <parameter>singleprice</parameter></term>
+ <listitem>
+ <para>Цена не зависит от времени стуок</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>boolean <parameter>nodiscount</parameter></term>
+ <listitem>
+ <para>Цена не зависит от порога</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect2>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para>
+ <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
+ <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
+ <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
+ <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="stargazer.add_tariff">
+ <refmeta>
+ <refentrytitle>stargazer.add_tariff</refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>stargazer.add_tariff</refname>
+ <refpurpose>Добавляет в систему новый тарифный план</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef><function>stargazer.add_tariff</function></funcdef>
+ <paramdef>string <parameter>cookie</parameter></paramdef>
+ <paramdef>string <parameter>tariff</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Метод <function>stargazer.add_tariff</function> добавляет в систему новый "пустой" тарифный план. Для его настройки используется метод <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>.</para>
+ <variablelist>
+ <varlistentry>
+ <term>string <parameter>cookie</parameter></term>
+ <listitem>
+ <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>string <parameter>tariff</parameter></term>
+ <listitem>
+ <para>Название тарифа</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <refsect2>
+ <title>Return Value</title>
+ <para>Возвращет true в случае успеха и false в случае неудачи</para>
+ </refsect2>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para>
+ <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
+ <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
+ <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
+ <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="stargazer.del_tariff">
+ <refmeta>
+ <refentrytitle>stargazer.del_tariff</refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>stargazer.del_tariff</refname>
+ <refpurpose>Удаляет из системы тарифный план</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef><function>stargazer.del_tariff</function></funcdef>
+ <paramdef>string <parameter>cookie</parameter></paramdef>
+ <paramdef>string <parameter>tariff</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Метод <function>stargazer.del_tariff</function> удаляет из системы тарифный план</para>
+ <variablelist>
+ <varlistentry>
+ <term>string <parameter>cookie</parameter></term>
+ <listitem>
+ <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>string <parameter>tariff</parameter></term>
+ <listitem>
+ <para>Название тарифа</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <refsect2>
+ <title>Return Value</title>
+ <para>Возвращет true в случае успеха и false в случае неудачи</para>
+ </refsect2>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para>
+ <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
+ <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
+ <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
+ <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="stargazer.chg_tariff">
+ <refmeta>
+ <refentrytitle>stargazer.chg_tariff</refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>stargazer.chg_tariff</refname>
+ <refpurpose>Изменяет информацию о тарифном плане</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef><function>stargazer.chg_tariff</function></funcdef>
+ <paramdef>string <parameter>cookie</parameter></paramdef>
+ <paramdef>string <parameter>tariff</parameter></paramdef>
+ <paramdef>struct <parameter>info</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Метод <function>stargazer.chg_tariff</function> изменяет информацию о тарифном плане. Допустимо частичное указание параметров в структуре info. В этом случае изменение затронет только указанные параметры. Дополнительные поля структуры (не входящие в описание) будут проигнорированы.</para>
+ <variablelist>
+ <varlistentry>
+ <term>string <parameter>cookie</parameter></term>
+ <listitem>
+ <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>string <parameter>tariff</parameter></term>
+ <listitem>
+ <para>Название тарифа</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>struct <parameter>info</parameter></term>
+ <listitem>
+ <para>
+ Структура с информацией о тарифном плане:
+ <variablelist>
+ <varlistentry>
+ <term>string <parameter>name</parameter></term>
+ <listitem>
+ <para>Название тарифа</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>fee</parameter></term>
+ <listitem>
+ <para>Абонплата</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>freemb</parameter></term>
+ <listitem>
+ <para>Количество свободных мегабайт, включенных в абонплату</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>passivecost</parameter></term>
+ <listitem>
+ <para>Стоимость заморозки пользователя</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>trafftype</parameter></term>
+ <listitem>
+ <para>Тип подсчета трафика:
+ <simplelist type="vert">
+ <member>0 — подсчитывать только исходящий трафик</member>
+ <member>1 — подсчитывать только входящий трафик</member>
+ <member>2 — подсчитывать суммарно входящий и исходящий трафик</member>
+ <member>3 — подсчитывать максимальный из входящего и исходящего трафика</member>
+ </simplelist>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>array of struct <parameter>dirprices</parameter></term>
+ <listitem>
+ <para>Массив стурктур, описывающих тарификацию направлений:
+ <variablelist>
+ <varlistentry>
+ <term>int <parameter>hday</parameter></term>
+ <listitem>
+ <para>Часы начала дня</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>mday</parameter></term>
+ <listitem>
+ <para>Минуты начала дня</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>hnight</parameter></term>
+ <listitem>
+ <para>Часы начала ночи</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>mnight</parameter></term>
+ <listitem>
+ <para>Минуты начала ночи</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricedaya</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricedayb</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricenighta</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>double <parameter>pricenightb</parameter></term>
+ <listitem>
+ <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int <parameter>threshold</parameter></term>
+ <listitem>
+ <para>Величина порога в мегабайтах</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>boolean <parameter>singleprice</parameter></term>
+ <listitem>
+ <para>Цена не зависит от времени стуок</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>boolean <parameter>nodiscount</parameter></term>
+ <listitem>
+ <para>Цена не зависит от порога</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <refsect2>
+ <title>Return Value</title>
+ <para>Возвращет true в случае успеха и false в случае неудачи</para>
+ </refsect2>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para>
+ <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
+ <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
+ <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
+ <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>
+ </para>
+ </refsect1>
+ </refentry>
+</chapter>
git.stg.codes / stg.git / blobdiff