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 — ежедневная абонплата (параметр Fee трактуется как значение списываемое ежедневно)</member>
122 <member>day — ежемесячная абонплата (классическая, параметр Fee трактуется как значение списываемое за месяц, в том числе в режиме SpreadFee)</member>
128 <term>string <parameter>changePolicy</parameter></term>
130 <para>Политика смены тарифа:
131 <simplelist type="vert">
132 <member>allow — на период действия политики смена тарифного плана разрешена</member>
133 <member>to_cheap — на период действия политики разрешена смена тарифного плана на более дешевый</member>
134 <member>to_expensive — на период действия политики разрешена смена тарифного плана на более дорогой</member>
135 <member>deny — на период действия политики смена тарифного плана запрещена</member>
141 <term>int <parameter>changePolicyTimeout</parameter></term>
143 <para>Момент завершения действия политики тарификации (0 - политика тарификации не завершается никогда)</para>
147 <term>array of struct <parameter>dirprices</parameter></term>
149 <para>Массив стурктур, описывающих тарификацию направлений:
152 <term>int <parameter>hday</parameter></term>
154 <para>Часы начала дня</para>
158 <term>int <parameter>mday</parameter></term>
160 <para>Минуты начала дня</para>
164 <term>int <parameter>hnight</parameter></term>
166 <para>Часы начала ночи</para>
170 <term>int <parameter>mnight</parameter></term>
172 <para>Минуты начала ночи</para>
176 <term>double <parameter>pricedaya</parameter></term>
178 <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
182 <term>double <parameter>pricedayb</parameter></term>
184 <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
188 <term>double <parameter>pricenighta</parameter></term>
190 <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
194 <term>double <parameter>pricenightb</parameter></term>
196 <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
200 <term>int <parameter>threshold</parameter></term>
202 <para>Величина порога в мегабайтах</para>
206 <term>boolean <parameter>singleprice</parameter></term>
208 <para>Цена не зависит от времени суток</para>
212 <term>boolean <parameter>nodiscount</parameter></term>
214 <para>Цена не зависит от порога</para>
226 <title>See also</title>
228 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
229 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
230 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
231 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
235 <refentry id="stargazer.get_tariffs">
237 <refentrytitle>stargazer.get_tariffs</refentrytitle>
240 <refname>stargazer.get_tariffs</refname>
241 <refpurpose>Получает информацию о тарифных планах</refpurpose>
246 <funcdef><function>stargazer.get_tariffs</function></funcdef>
247 <paramdef>string <parameter>cookie</parameter></paramdef>
252 <title>Description</title>
253 <para>Метод <function>stargazer.get_tariffs</function> получает информацию о тарифных планах.</para>
256 <term>string <parameter>cookie</parameter></term>
258 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
263 <title>Return Value</title>
265 Возвращает массив структур:
268 <term>boolean <parameter>result</parameter></term>
270 <para>Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie, неправильное название тарифа).</para>
274 <term>string <parameter>name</parameter></term>
276 <para>Название тарифа</para>
280 <term>double <parameter>fee</parameter></term>
282 <para>Абонплата</para>
286 <term>double <parameter>freemb</parameter></term>
288 <para>Количество бесплатных мегабайт включенных в абонплату</para>
292 <term>double <parameter>passivecost</parameter></term>
294 <para>Стоимость "заморозки" пользователя</para>
298 <term>int <parameter>trafftype</parameter></term>
300 <para>Тип подсчета трафика:
301 <simplelist type="vert">
302 <member>0 — подсчитывать только исходящий трафик</member>
303 <member>1 — подсчитывать только входящий трафик</member>
304 <member>2 — подсчитывать суммарно входящий и исходящий трафик</member>
305 <member>3 — подсчитывать максимальный из входящего и исходящего трафика</member>
311 <term>string <parameter>period</parameter></term>
313 <para>Периодичность снятия абонплаты:
314 <simplelist type="vert">
315 <member>month — ежедневная абонплата (параметр Fee трактуется как значение списываемое ежедневно)</member>
316 <member>day — ежемесячная абонплата (классическая, параметр Fee трактуется как значение списываемое за месяц, в том числе в режиме SpreadFee)</member>
322 <term>string <parameter>changePolicy</parameter></term>
324 <para>Политика смены тарифа:
325 <simplelist type="vert">
326 <member>allow — на период действия политики смена тарифного плана разрешена</member>
327 <member>to_cheap — на период действия политики разрешена смена тарифного плана на более дешевый</member>
328 <member>to_expensive — на период действия политики разрешена смена тарифного плана на более дорогой</member>
329 <member>deny — на период действия политики смена тарифного плана запрещена</member>
335 <term>int <parameter>changePolicyTimeout</parameter></term>
337 <para>Момент завершения действия политики тарификации (0 - политика тарификации не завершается никогда)</para>
341 <term>array of struct <parameter>dirprices</parameter></term>
343 <para>Массив стурктур, описывающих тарификацию направлений:
346 <term>int <parameter>hday</parameter></term>
348 <para>Часы начала дня</para>
352 <term>int <parameter>mday</parameter></term>
354 <para>Минуты начала дня</para>
358 <term>int <parameter>hnight</parameter></term>
360 <para>Часы начала ночи</para>
364 <term>int <parameter>mnight</parameter></term>
366 <para>Минуты начала ночи</para>
370 <term>double <parameter>pricedaya</parameter></term>
372 <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
376 <term>double <parameter>pricedayb</parameter></term>
378 <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
382 <term>double <parameter>pricenighta</parameter></term>
384 <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
388 <term>double <parameter>pricenightb</parameter></term>
390 <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
394 <term>int <parameter>threshold</parameter></term>
396 <para>Величина порога в мегабайтах</para>
400 <term>boolean <parameter>singleprice</parameter></term>
402 <para>Цена не зависит от времени стуок</para>
406 <term>boolean <parameter>nodiscount</parameter></term>
408 <para>Цена не зависит от порога</para>
420 <title>See also</title>
422 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
423 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
424 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
425 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
429 <refentry id="stargazer.add_tariff">
431 <refentrytitle>stargazer.add_tariff</refentrytitle>
434 <refname>stargazer.add_tariff</refname>
435 <refpurpose>Добавляет в систему новый тарифный план</refpurpose>
440 <funcdef><function>stargazer.add_tariff</function></funcdef>
441 <paramdef>string <parameter>cookie</parameter></paramdef>
442 <paramdef>string <parameter>tariff</parameter></paramdef>
447 <title>Description</title>
448 <para>Метод <function>stargazer.add_tariff</function> добавляет в систему новый "пустой" тарифный план. Для его настройки используется метод <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>.</para>
451 <term>string <parameter>cookie</parameter></term>
453 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
457 <term>string <parameter>tariff</parameter></term>
459 <para>Название тарифа</para>
464 <title>Return Value</title>
465 <para>Возвращет true в случае успеха и false в случае неудачи</para>
469 <title>See also</title>
471 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
472 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
473 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
474 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
478 <refentry id="stargazer.del_tariff">
480 <refentrytitle>stargazer.del_tariff</refentrytitle>
483 <refname>stargazer.del_tariff</refname>
484 <refpurpose>Удаляет из системы тарифный план</refpurpose>
489 <funcdef><function>stargazer.del_tariff</function></funcdef>
490 <paramdef>string <parameter>cookie</parameter></paramdef>
491 <paramdef>string <parameter>tariff</parameter></paramdef>
496 <title>Description</title>
497 <para>Метод <function>stargazer.del_tariff</function> удаляет из системы тарифный план</para>
500 <term>string <parameter>cookie</parameter></term>
502 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
506 <term>string <parameter>tariff</parameter></term>
508 <para>Название тарифа</para>
513 <title>Return Value</title>
514 <para>Возвращет true в случае успеха и false в случае неудачи</para>
518 <title>See also</title>
520 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
521 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
522 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
523 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
527 <refentry id="stargazer.chg_tariff">
529 <refentrytitle>stargazer.chg_tariff</refentrytitle>
532 <refname>stargazer.chg_tariff</refname>
533 <refpurpose>Изменяет информацию о тарифном плане</refpurpose>
538 <funcdef><function>stargazer.chg_tariff</function></funcdef>
539 <paramdef>string <parameter>cookie</parameter></paramdef>
540 <paramdef>string <parameter>tariff</parameter></paramdef>
541 <paramdef>struct <parameter>info</parameter></paramdef>
546 <title>Description</title>
547 <para>Метод <function>stargazer.chg_tariff</function> изменяет информацию о тарифном плане. Допустимо частичное указание параметров в структуре info. В этом случае изменение затронет только указанные параметры. Дополнительные поля структуры (не входящие в описание) будут проигнорированы.</para>
550 <term>string <parameter>cookie</parameter></term>
552 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
556 <term>string <parameter>tariff</parameter></term>
558 <para>Название тарифа</para>
562 <term>struct <parameter>info</parameter></term>
565 Структура с информацией о тарифном плане:
568 <term>string <parameter>name</parameter></term>
570 <para>Название тарифа</para>
574 <term>double <parameter>fee</parameter></term>
576 <para>Абонплата</para>
580 <term>double <parameter>freemb</parameter></term>
582 <para>Количество свободных мегабайт, включенных в абонплату</para>
586 <term>double <parameter>passivecost</parameter></term>
588 <para>Стоимость заморозки пользователя</para>
592 <term>int <parameter>trafftype</parameter></term>
594 <para>Тип подсчета трафика:
595 <simplelist type="vert">
596 <member>0 — подсчитывать только исходящий трафик</member>
597 <member>1 — подсчитывать только входящий трафик</member>
598 <member>2 — подсчитывать суммарно входящий и исходящий трафик</member>
599 <member>3 — подсчитывать максимальный из входящего и исходящего трафика</member>
605 <term>string <parameter>period</parameter></term>
607 <para>Периодичность снятия абонплаты:
608 <simplelist type="vert">
609 <member>month — ежедневная абонплата (параметр Fee трактуется как значение списываемое ежедневно)</member>
610 <member>day — ежемесячная абонплата (классическая, параметр Fee трактуется как значение списываемое за месяц, в том числе в режиме SpreadFee)</member>
616 <term>string <parameter>changePolicy</parameter></term>
618 <para>Политика смены тарифа:
619 <simplelist type="vert">
620 <member>allow — на период действия политики смена тарифного плана разрешена</member>
621 <member>to_cheap — на период действия политики разрешена смена тарифного плана на более дешевый</member>
622 <member>to_expensive — на период действия политики разрешена смена тарифного плана на более дорогой</member>
623 <member>deny — на период действия политики смена тарифного плана запрещена</member>
629 <term>int <parameter>changePolicyTimeout</parameter></term>
631 <para>Момент завершения действия политики тарификации (0 - политика тарификации не завершается никогда)</para>
635 <term>array of struct <parameter>dirprices</parameter></term>
637 <para>Массив стурктур, описывающих тарификацию направлений:
640 <term>int <parameter>hday</parameter></term>
642 <para>Часы начала дня</para>
646 <term>int <parameter>mday</parameter></term>
648 <para>Минуты начала дня</para>
652 <term>int <parameter>hnight</parameter></term>
654 <para>Часы начала ночи</para>
658 <term>int <parameter>mnight</parameter></term>
660 <para>Минуты начала ночи</para>
664 <term>double <parameter>pricedaya</parameter></term>
666 <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
670 <term>double <parameter>pricedayb</parameter></term>
672 <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
676 <term>double <parameter>pricenighta</parameter></term>
678 <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
682 <term>double <parameter>pricenightb</parameter></term>
684 <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
688 <term>int <parameter>threshold</parameter></term>
690 <para>Величина порога в мегабайтах</para>
694 <term>boolean <parameter>singleprice</parameter></term>
696 <para>Цена не зависит от времени стуок</para>
700 <term>boolean <parameter>nodiscount</parameter></term>
702 <para>Цена не зависит от порога</para>
715 <title>Return Value</title>
716 <para>Возвращет true в случае успеха и false в случае неудачи</para>
720 <title>See also</title>
722 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
723 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
724 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
725 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>