1 <?xml version='1.0' encoding='UTF-8'?>
2 <chapter xmlns="http://docbook.org/ns/docbook">
3 <title>Управление тарифами</title>
4 <para>В этом разделе собраны вызовы для манипулирования тарифными планами. Тарифный план включает в себя:</para>
6 <listitem><para>название;</para></listitem>
7 <listitem><para>абонплата;</para></listitem>
8 <listitem><para>количество бесплатных мегабайт, включенных в абонплату;</para></listitem>
9 <listitem><para>стоимость "заморозки" пользователя;</para></listitem>
11 <para>тип подсчета трафика:</para>
13 <listitem><para>только входящий,</para></listitem>
14 <listitem><para>только исходящий,</para></listitem>
15 <listitem><para>входящий и исходящий суммарно,</para></listitem>
16 <listitem><para>максимум из входящего и исходящего</para></listitem>
20 <para>информацию о тарификации направлений:</para>
22 <listitem><para>время начала дня;</para></listitem>
23 <listitem><para>конца дня;</para></listitem>
24 <listitem><para>цена за мегабайт трафика до порога днем;</para></listitem>
25 <listitem><para>цена за мегабайт трафика после порога днем;</para></listitem>
26 <listitem><para>цена за мегабайт трафика до порога ночью;</para></listitem>
27 <listitem><para>цена за мегабайт трафика после порога ночью;</para></listitem>
28 <listitem><para>пороговый объем трафика в мегабайтах;</para></listitem>
29 <listitem><para>флаг игнорирования времени суток;</para></listitem>
30 <listitem><para>флаг игнорирования порога.</para></listitem>
34 <refentry id="stargazer.get_tariff">
36 <refentrytitle>stargazer.get_tariff</refentrytitle>
39 <refname>stargazer.get_tariff</refname>
40 <refpurpose>Получает информацию о тарифном плане</refpurpose>
45 <funcdef><function>stargazer.get_tariff</function></funcdef>
46 <paramdef>string <parameter>cookie</parameter></paramdef>
47 <paramdef>string <parameter>tariff</parameter></paramdef>
52 <title>Description</title>
53 <para>Метод <function>stargazer.get_tariff</function> получает информацию о тарифном плане.</para>
56 <term>string <parameter>cookie</parameter></term>
58 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
62 <term>string <parameter>tariff</parameter></term>
64 <para>Название тарифа</para>
69 <title>Return Value</title>
74 <term>boolean <parameter>result</parameter></term>
76 <para>Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie, неправильное название тарифа).</para>
80 <term>string <parameter>name</parameter></term>
82 <para>Название тарифа</para>
86 <term>double <parameter>fee</parameter></term>
88 <para>Абонплата</para>
92 <term>double <parameter>freemb</parameter></term>
94 <para>Количество бесплатных мегабайт включенных в абонплату</para>
98 <term>double <parameter>passivecost</parameter></term>
100 <para>Стоимость "заморозки" пользователя</para>
104 <term>int <parameter>trafftype</parameter></term>
106 <para>Тип подсчета трафика:
107 <simplelist type="vert">
108 <member>0 — подсчитывать только исходящий трафик</member>
109 <member>1 — подсчитывать только входящий трафик</member>
110 <member>2 — подсчитывать суммарно входящий и исходящий трафик</member>
111 <member>3 — подсчитывать максимальный из входящего и исходящего трафика</member>
117 <term>string <parameter>period</parameter></term>
119 <para>Периодичность снятия абонплаты:
120 <simplelist type="vert">
121 <member>month — ежемесячное снятие</member>
122 <member>day — ежедневное снятие</member>
128 <term>array of struct <parameter>dirprices</parameter></term>
130 <para>Массив стурктур, описывающих тарификацию направлений:
133 <term>int <parameter>hday</parameter></term>
135 <para>Часы начала дня</para>
139 <term>int <parameter>mday</parameter></term>
141 <para>Минуты начала дня</para>
145 <term>int <parameter>hnight</parameter></term>
147 <para>Часы начала ночи</para>
151 <term>int <parameter>mnight</parameter></term>
153 <para>Минуты начала ночи</para>
157 <term>double <parameter>pricedaya</parameter></term>
159 <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
163 <term>double <parameter>pricedayb</parameter></term>
165 <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
169 <term>double <parameter>pricenighta</parameter></term>
171 <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
175 <term>double <parameter>pricenightb</parameter></term>
177 <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
181 <term>int <parameter>threshold</parameter></term>
183 <para>Величина порога в мегабайтах</para>
187 <term>boolean <parameter>singleprice</parameter></term>
189 <para>Цена не зависит от времени суток</para>
193 <term>boolean <parameter>nodiscount</parameter></term>
195 <para>Цена не зависит от порога</para>
207 <title>See also</title>
209 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
210 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
211 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
212 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
216 <refentry id="stargazer.get_tariffs">
218 <refentrytitle>stargazer.get_tariffs</refentrytitle>
221 <refname>stargazer.get_tariffs</refname>
222 <refpurpose>Получает информацию о тарифных планах</refpurpose>
227 <funcdef><function>stargazer.get_tariffs</function></funcdef>
228 <paramdef>string <parameter>cookie</parameter></paramdef>
233 <title>Description</title>
234 <para>Метод <function>stargazer.get_tariffs</function> получает информацию о тарифных планах.</para>
237 <term>string <parameter>cookie</parameter></term>
239 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
244 <title>Return Value</title>
246 Возвращает массив структур:
249 <term>boolean <parameter>result</parameter></term>
251 <para>Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie, неправильное название тарифа).</para>
255 <term>string <parameter>name</parameter></term>
257 <para>Название тарифа</para>
261 <term>double <parameter>fee</parameter></term>
263 <para>Абонплата</para>
267 <term>double <parameter>freemb</parameter></term>
269 <para>Количество бесплатных мегабайт включенных в абонплату</para>
273 <term>double <parameter>passivecost</parameter></term>
275 <para>Стоимость "заморозки" пользователя</para>
279 <term>int <parameter>trafftype</parameter></term>
281 <para>Тип подсчета трафика:
282 <simplelist type="vert">
283 <member>0 — подсчитывать только исходящий трафик</member>
284 <member>1 — подсчитывать только входящий трафик</member>
285 <member>2 — подсчитывать суммарно входящий и исходящий трафик</member>
286 <member>3 — подсчитывать максимальный из входящего и исходящего трафика</member>
292 <term>string <parameter>period</parameter></term>
294 <para>Периодичность снятия абонплаты:
295 <simplelist type="vert">
296 <member>month — ежемесячное снятие</member>
297 <member>day — ежедневное снятие</member>
303 <term>array of struct <parameter>dirprices</parameter></term>
305 <para>Массив стурктур, описывающих тарификацию направлений:
308 <term>int <parameter>hday</parameter></term>
310 <para>Часы начала дня</para>
314 <term>int <parameter>mday</parameter></term>
316 <para>Минуты начала дня</para>
320 <term>int <parameter>hnight</parameter></term>
322 <para>Часы начала ночи</para>
326 <term>int <parameter>mnight</parameter></term>
328 <para>Минуты начала ночи</para>
332 <term>double <parameter>pricedaya</parameter></term>
334 <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
338 <term>double <parameter>pricedayb</parameter></term>
340 <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
344 <term>double <parameter>pricenighta</parameter></term>
346 <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
350 <term>double <parameter>pricenightb</parameter></term>
352 <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
356 <term>int <parameter>threshold</parameter></term>
358 <para>Величина порога в мегабайтах</para>
362 <term>boolean <parameter>singleprice</parameter></term>
364 <para>Цена не зависит от времени стуок</para>
368 <term>boolean <parameter>nodiscount</parameter></term>
370 <para>Цена не зависит от порога</para>
382 <title>See also</title>
384 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
385 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
386 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
387 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
391 <refentry id="stargazer.add_tariff">
393 <refentrytitle>stargazer.add_tariff</refentrytitle>
396 <refname>stargazer.add_tariff</refname>
397 <refpurpose>Добавляет в систему новый тарифный план</refpurpose>
402 <funcdef><function>stargazer.add_tariff</function></funcdef>
403 <paramdef>string <parameter>cookie</parameter></paramdef>
404 <paramdef>string <parameter>tariff</parameter></paramdef>
409 <title>Description</title>
410 <para>Метод <function>stargazer.add_tariff</function> добавляет в систему новый "пустой" тарифный план. Для его настройки используется метод <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>.</para>
413 <term>string <parameter>cookie</parameter></term>
415 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
419 <term>string <parameter>tariff</parameter></term>
421 <para>Название тарифа</para>
426 <title>Return Value</title>
427 <para>Возвращет true в случае успеха и false в случае неудачи</para>
431 <title>See also</title>
433 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
434 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
435 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
436 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
440 <refentry id="stargazer.del_tariff">
442 <refentrytitle>stargazer.del_tariff</refentrytitle>
445 <refname>stargazer.del_tariff</refname>
446 <refpurpose>Удаляет из системы тарифный план</refpurpose>
451 <funcdef><function>stargazer.del_tariff</function></funcdef>
452 <paramdef>string <parameter>cookie</parameter></paramdef>
453 <paramdef>string <parameter>tariff</parameter></paramdef>
458 <title>Description</title>
459 <para>Метод <function>stargazer.del_tariff</function> удаляет из системы тарифный план</para>
462 <term>string <parameter>cookie</parameter></term>
464 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
468 <term>string <parameter>tariff</parameter></term>
470 <para>Название тарифа</para>
475 <title>Return Value</title>
476 <para>Возвращет true в случае успеха и false в случае неудачи</para>
480 <title>See also</title>
482 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
483 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
484 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
485 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
489 <refentry id="stargazer.chg_tariff">
491 <refentrytitle>stargazer.chg_tariff</refentrytitle>
494 <refname>stargazer.chg_tariff</refname>
495 <refpurpose>Изменяет информацию о тарифном плане</refpurpose>
500 <funcdef><function>stargazer.chg_tariff</function></funcdef>
501 <paramdef>string <parameter>cookie</parameter></paramdef>
502 <paramdef>string <parameter>tariff</parameter></paramdef>
503 <paramdef>struct <parameter>info</parameter></paramdef>
508 <title>Description</title>
509 <para>Метод <function>stargazer.chg_tariff</function> изменяет информацию о тарифном плане. Допустимо частичное указание параметров в структуре info. В этом случае изменение затронет только указанные параметры. Дополнительные поля структуры (не входящие в описание) будут проигнорированы.</para>
512 <term>string <parameter>cookie</parameter></term>
514 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
518 <term>string <parameter>tariff</parameter></term>
520 <para>Название тарифа</para>
524 <term>struct <parameter>info</parameter></term>
527 Структура с информацией о тарифном плане:
530 <term>string <parameter>name</parameter></term>
532 <para>Название тарифа</para>
536 <term>double <parameter>fee</parameter></term>
538 <para>Абонплата</para>
542 <term>double <parameter>freemb</parameter></term>
544 <para>Количество свободных мегабайт, включенных в абонплату</para>
548 <term>double <parameter>passivecost</parameter></term>
550 <para>Стоимость заморозки пользователя</para>
554 <term>int <parameter>trafftype</parameter></term>
556 <para>Тип подсчета трафика:
557 <simplelist type="vert">
558 <member>0 — подсчитывать только исходящий трафик</member>
559 <member>1 — подсчитывать только входящий трафик</member>
560 <member>2 — подсчитывать суммарно входящий и исходящий трафик</member>
561 <member>3 — подсчитывать максимальный из входящего и исходящего трафика</member>
567 <term>string <parameter>period</parameter></term>
569 <para>Периодичность снятия абонплаты:
570 <simplelist type="vert">
571 <member>month — ежемесячное снятие</member>
572 <member>day — ежедневное снятие</member>
578 <term>array of struct <parameter>dirprices</parameter></term>
580 <para>Массив стурктур, описывающих тарификацию направлений:
583 <term>int <parameter>hday</parameter></term>
585 <para>Часы начала дня</para>
589 <term>int <parameter>mday</parameter></term>
591 <para>Минуты начала дня</para>
595 <term>int <parameter>hnight</parameter></term>
597 <para>Часы начала ночи</para>
601 <term>int <parameter>mnight</parameter></term>
603 <para>Минуты начала ночи</para>
607 <term>double <parameter>pricedaya</parameter></term>
609 <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
613 <term>double <parameter>pricedayb</parameter></term>
615 <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
619 <term>double <parameter>pricenighta</parameter></term>
621 <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
625 <term>double <parameter>pricenightb</parameter></term>
627 <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
631 <term>int <parameter>threshold</parameter></term>
633 <para>Величина порога в мегабайтах</para>
637 <term>boolean <parameter>singleprice</parameter></term>
639 <para>Цена не зависит от времени стуок</para>
643 <term>boolean <parameter>nodiscount</parameter></term>
645 <para>Цена не зависит от порога</para>
658 <title>Return Value</title>
659 <para>Возвращет true в случае успеха и false в случае неудачи</para>
663 <title>See also</title>
665 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
666 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
667 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
668 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>