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>array of struct <parameter>dirprices</parameter></term>
119 <para>Массив стурктур, описывающих тарификацию направлений:
122 <term>int <parameter>hday</parameter></term>
124 <para>Часы начала дня</para>
128 <term>int <parameter>mday</parameter></term>
130 <para>Минуты начала дня</para>
134 <term>int <parameter>hnight</parameter></term>
136 <para>Часы начала ночи</para>
140 <term>int <parameter>mnight</parameter></term>
142 <para>Минуты начала ночи</para>
146 <term>double <parameter>pricedaya</parameter></term>
148 <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
152 <term>double <parameter>pricedayb</parameter></term>
154 <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
158 <term>double <parameter>pricenighta</parameter></term>
160 <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
164 <term>double <parameter>pricenightb</parameter></term>
166 <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
170 <term>int <parameter>threshold</parameter></term>
172 <para>Величина порога в мегабайтах</para>
176 <term>boolean <parameter>singleprice</parameter></term>
178 <para>Цена не зависит от времени суток</para>
182 <term>boolean <parameter>nodiscount</parameter></term>
184 <para>Цена не зависит от порога</para>
196 <title>See also</title>
198 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
199 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
200 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
201 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
205 <refentry id="stargazer.get_tariffs">
207 <refentrytitle>stargazer.get_tariffs</refentrytitle>
210 <refname>stargazer.get_tariffs</refname>
211 <refpurpose>Получает информацию о тарифных планах</refpurpose>
216 <funcdef><function>stargazer.get_tariffs</function></funcdef>
217 <paramdef>string <parameter>cookie</parameter></paramdef>
222 <title>Description</title>
223 <para>Метод <function>stargazer.get_tariffs</function> получает информацию о тарифных планах.</para>
226 <term>string <parameter>cookie</parameter></term>
228 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
233 <title>Return Value</title>
235 Возвращает массив структур:
238 <term>boolean <parameter>result</parameter></term>
240 <para>Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie, неправильное название тарифа).</para>
244 <term>string <parameter>name</parameter></term>
246 <para>Название тарифа</para>
250 <term>double <parameter>fee</parameter></term>
252 <para>Абонплата</para>
256 <term>double <parameter>freemb</parameter></term>
258 <para>Количество бесплатных мегабайт включенных в абонплату</para>
262 <term>double <parameter>passivecost</parameter></term>
264 <para>Стоимость "заморозки" пользователя</para>
268 <term>int <parameter>trafftype</parameter></term>
270 <para>Тип подсчета трафика:
271 <simplelist type="vert">
272 <member>0 — подсчитывать только исходящий трафик</member>
273 <member>1 — подсчитывать только входящий трафик</member>
274 <member>2 — подсчитывать суммарно входящий и исходящий трафик</member>
275 <member>3 — подсчитывать максимальный из входящего и исходящего трафика</member>
281 <term>array of struct <parameter>dirprices</parameter></term>
283 <para>Массив стурктур, описывающих тарификацию направлений:
286 <term>int <parameter>hday</parameter></term>
288 <para>Часы начала дня</para>
292 <term>int <parameter>mday</parameter></term>
294 <para>Минуты начала дня</para>
298 <term>int <parameter>hnight</parameter></term>
300 <para>Часы начала ночи</para>
304 <term>int <parameter>mnight</parameter></term>
306 <para>Минуты начала ночи</para>
310 <term>double <parameter>pricedaya</parameter></term>
312 <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
316 <term>double <parameter>pricedayb</parameter></term>
318 <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
322 <term>double <parameter>pricenighta</parameter></term>
324 <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
328 <term>double <parameter>pricenightb</parameter></term>
330 <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
334 <term>int <parameter>threshold</parameter></term>
336 <para>Величина порога в мегабайтах</para>
340 <term>boolean <parameter>singleprice</parameter></term>
342 <para>Цена не зависит от времени стуок</para>
346 <term>boolean <parameter>nodiscount</parameter></term>
348 <para>Цена не зависит от порога</para>
360 <title>See also</title>
362 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
363 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
364 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
365 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
369 <refentry id="stargazer.add_tariff">
371 <refentrytitle>stargazer.add_tariff</refentrytitle>
374 <refname>stargazer.add_tariff</refname>
375 <refpurpose>Добавляет в систему новый тарифный план</refpurpose>
380 <funcdef><function>stargazer.add_tariff</function></funcdef>
381 <paramdef>string <parameter>cookie</parameter></paramdef>
382 <paramdef>string <parameter>tariff</parameter></paramdef>
387 <title>Description</title>
388 <para>Метод <function>stargazer.add_tariff</function> добавляет в систему новый "пустой" тарифный план. Для его настройки используется метод <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>.</para>
391 <term>string <parameter>cookie</parameter></term>
393 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
397 <term>string <parameter>tariff</parameter></term>
399 <para>Название тарифа</para>
404 <title>Return Value</title>
405 <para>Возвращет true в случае успеха и false в случае неудачи</para>
409 <title>See also</title>
411 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
412 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
413 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>,
414 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
418 <refentry id="stargazer.del_tariff">
420 <refentrytitle>stargazer.del_tariff</refentrytitle>
423 <refname>stargazer.del_tariff</refname>
424 <refpurpose>Удаляет из системы тарифный план</refpurpose>
429 <funcdef><function>stargazer.del_tariff</function></funcdef>
430 <paramdef>string <parameter>cookie</parameter></paramdef>
431 <paramdef>string <parameter>tariff</parameter></paramdef>
436 <title>Description</title>
437 <para>Метод <function>stargazer.del_tariff</function> удаляет из системы тарифный план</para>
440 <term>string <parameter>cookie</parameter></term>
442 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
446 <term>string <parameter>tariff</parameter></term>
448 <para>Название тарифа</para>
453 <title>Return Value</title>
454 <para>Возвращет true в случае успеха и false в случае неудачи</para>
458 <title>See also</title>
460 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
461 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
462 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
463 <link linkend="stargazer.chg_tariff"><function>stargazer.chg_tariff</function></link>
467 <refentry id="stargazer.chg_tariff">
469 <refentrytitle>stargazer.chg_tariff</refentrytitle>
472 <refname>stargazer.chg_tariff</refname>
473 <refpurpose>Изменяет информацию о тарифном плане</refpurpose>
478 <funcdef><function>stargazer.chg_tariff</function></funcdef>
479 <paramdef>string <parameter>cookie</parameter></paramdef>
480 <paramdef>string <parameter>tariff</parameter></paramdef>
481 <paramdef>struct <parameter>info</parameter></paramdef>
486 <title>Description</title>
487 <para>Метод <function>stargazer.chg_tariff</function> изменяет информацию о тарифном плане. Допустимо частичное указание параметров в структуре info. В этом случае изменение затронет только указанные параметры. Дополнительные поля структуры (не входящие в описание) будут проигнорированы.</para>
490 <term>string <parameter>cookie</parameter></term>
492 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
496 <term>string <parameter>tariff</parameter></term>
498 <para>Название тарифа</para>
502 <term>struct <parameter>info</parameter></term>
505 Структура с информацией о тарифном плане:
508 <term>string <parameter>name</parameter></term>
510 <para>Название тарифа</para>
514 <term>double <parameter>fee</parameter></term>
516 <para>Абонплата</para>
520 <term>double <parameter>freemb</parameter></term>
522 <para>Количество свободных мегабайт, включенных в абонплату</para>
526 <term>double <parameter>passivecost</parameter></term>
528 <para>Стоимость заморозки пользователя</para>
532 <term>int <parameter>trafftype</parameter></term>
534 <para>Тип подсчета трафика:
535 <simplelist type="vert">
536 <member>0 — подсчитывать только исходящий трафик</member>
537 <member>1 — подсчитывать только входящий трафик</member>
538 <member>2 — подсчитывать суммарно входящий и исходящий трафик</member>
539 <member>3 — подсчитывать максимальный из входящего и исходящего трафика</member>
545 <term>array of struct <parameter>dirprices</parameter></term>
547 <para>Массив стурктур, описывающих тарификацию направлений:
550 <term>int <parameter>hday</parameter></term>
552 <para>Часы начала дня</para>
556 <term>int <parameter>mday</parameter></term>
558 <para>Минуты начала дня</para>
562 <term>int <parameter>hnight</parameter></term>
564 <para>Часы начала ночи</para>
568 <term>int <parameter>mnight</parameter></term>
570 <para>Минуты начала ночи</para>
574 <term>double <parameter>pricedaya</parameter></term>
576 <para>Цена 1 мегабайта трафика днем до превышения порогового значения</para>
580 <term>double <parameter>pricedayb</parameter></term>
582 <para>Цена 1 мегабайта трафика днем после превышения порогового значения</para>
586 <term>double <parameter>pricenighta</parameter></term>
588 <para>Цена 1 мегабайта трафика ночью до превышения порогового значения</para>
592 <term>double <parameter>pricenightb</parameter></term>
594 <para>Цена 1 мегабайта трафика ночью после превышения порогового значения</para>
598 <term>int <parameter>threshold</parameter></term>
600 <para>Величина порога в мегабайтах</para>
604 <term>boolean <parameter>singleprice</parameter></term>
606 <para>Цена не зависит от времени стуок</para>
610 <term>boolean <parameter>nodiscount</parameter></term>
612 <para>Цена не зависит от порога</para>
625 <title>Return Value</title>
626 <para>Возвращет true в случае успеха и false в случае неудачи</para>
630 <title>See also</title>
632 <link linkend="stargazer.get_tariffs"><function>stargazer.get_tariffs</function></link>,
633 <link linkend="stargazer.get_tariff"><function>stargazer.get_tariff</function></link>,
634 <link linkend="stargazer.add_tariff"><function>stargazer.add_tariff</function></link>,
635 <link linkend="stargazer.del_tariff"><function>stargazer.del_tariff</function></link>