Rename some XML-RPC API methods

[stg.git] / doc / xmlrpc-doc / API-user.xml

diff --git a/doc/xmlrpc-doc/API-user.xml b/doc/xmlrpc-doc/API-user.xml
index 975b48eff1b9b492c5c58bbbc7acd88e3383264c..fac4f2be8b597e2d3a7354b99842cd7d23a0e021 100644 (file)
--- a/doc/xmlrpc-doc/API-user.xml
+++ b/doc/xmlrpc-doc/API-user.xml
@@ -155,7 +155,7 @@
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             </listitem>
                         </varlistentry>
                         <varlistentry>

-                            <term>boolean <structfield>disabledetailstat</structfield></term>
+                            <term>boolean <structfield>disableddetailstat</structfield></term>

                             <listitem>
                                 <para>Для пользователя отключено ведение детальной статистики</para>
                             </listitem>
                             <listitem>
                                 <para>Для пользователя отключено ведение детальной статистики</para>
                             </listitem>


@@ -239,9 +239,9 @@
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,

-                <link linkend="stargazer.add_cash"><function>stargazer.add_cash</function></link>,
-                <link linkend="stargazer.set_cash"><function>stargazer.set_cash</function></link>,
-                <link linkend="stargazer.change_tariff"><function>stargazer.change_tariff</function></link>
+                <link linkend="stargazer.add_user_cash"><function>stargazer.add_user_cash</function></link>,
+                <link linkend="stargazer.set_user_cash"><function>stargazer.set_user_cash</function></link>,
+                <link linkend="stargazer.chg_user_tariff"><function>stargazer.chg_user_tariff</function></link>

                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>
                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>


@@ -393,7 +393,7 @@
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             </listitem>
                         </varlistentry>
                         <varlistentry>

-                            <term>boolean <structfield>disabledetailstat</structfield></term>
+                            <term>boolean <structfield>disableddetailstat</structfield></term>

                             <listitem>
                                 <para>Для пользователя отключено ведение детальной статистики</para>
                             </listitem>
                             <listitem>
                                 <para>Для пользователя отключено ведение детальной статистики</para>
                             </listitem>


@@ -477,9 +477,9 @@
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,

-                <link linkend="stargazer.add_cash"><function>stargazer.add_cash</function></link>,
-                <link linkend="stargazer.set_cash"><function>stargazer.set_cash</function></link>,
-                <link linkend="stargazer.change_tariff"><function>stargazer.change_tariff</function></link>
+                <link linkend="stargazer.add_user_cash"><function>stargazer.add_user_cash</function></link>,
+                <link linkend="stargazer.set_user_cash"><function>stargazer.set_user_cash</function></link>,
+                <link linkend="stargazer.chg_user_tariff"><function>stargazer.chg_user_tariff</function></link>

                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>
                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>


@@ -530,9 +530,9 @@
                 <link linkend="stargazer.get_user"><function>stargazer.get_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,
                 <link linkend="stargazer.get_user"><function>stargazer.get_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,

-                <link linkend="stargazer.add_cash"><function>stargazer.add_cash</function></link>,
-                <link linkend="stargazer.set_cash"><function>stargazer.set_cash</function></link>,
-                <link linkend="stargazer.change_tariff"><function>stargazer.change_tariff</function></link>
+                <link linkend="stargazer.add_user_cash"><function>stargazer.add_user_cash</function></link>,
+                <link linkend="stargazer.set_user_cash"><function>stargazer.set_user_cash</function></link>,
+                <link linkend="stargazer.chg_user_tariff"><function>stargazer.chg_user_tariff</function></link>

                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>
                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>


@@ -550,6 +550,7 @@
                 <funcprototype>
                     <funcdef><function>stargazer.chg_user</function></funcdef>
                     <paramdef>string <parameter>cookie</parameter></paramdef>
                 <funcprototype>
                     <funcdef><function>stargazer.chg_user</function></funcdef>
                     <paramdef>string <parameter>cookie</parameter></paramdef>

+                    <paramdef>string <parameter>login</parameter></paramdef>

                     <paramdef>struct <parameter>info</parameter></paramdef>
                 </funcprototype>
             </funcsynopsis>
                     <paramdef>struct <parameter>info</parameter></paramdef>
                 </funcprototype>
             </funcsynopsis>


@@ -564,6 +565,12 @@
                         <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
                     </listitem>
                 </varlistentry>
                         <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
                     </listitem>
                 </varlistentry>

+                <varlistentry>
+                    <term>string <parameter>login</parameter></term>
+                    <listitem>
+                        <para>Логин пользователя</para>
+                    </listitem>
+                </varlistentry>

                 <varlistentry>
                     <term>struct <parameter>info</parameter></term>
                     <listitem>
                 <varlistentry>
                     <term>struct <parameter>info</parameter></term>
                     <listitem>


@@ -673,7 +680,7 @@
                                     </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                     </listitem>
                                 </varlistentry>
                                 <varlistentry>

-                                    <term>boolean <structfield>disabledetailstat</structfield></term>
+                                    <term>boolean <structfield>disableddetailstat</structfield></term>

                                     <listitem>
                                         <para>Для пользователя отключено ведение детальной статистики</para>
                                     </listitem>
                                     <listitem>
                                         <para>Для пользователя отключено ведение детальной статистики</para>
                                     </listitem>


@@ -721,9 +728,9 @@
                 <link linkend="stargazer.get_user"><function>stargazer.get_user</function></link>,
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,
                 <link linkend="stargazer.get_user"><function>stargazer.get_user</function></link>,
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,

-                <link linkend="stargazer.add_cash"><function>stargazer.add_cash</function></link>,
-                <link linkend="stargazer.set_cash"><function>stargazer.set_cash</function></link>,
-                <link linkend="stargazer.change_tariff"><function>stargazer.change_tariff</function></link>
+                <link linkend="stargazer.add_user_cash"><function>stargazer.add_user_cash</function></link>,
+                <link linkend="stargazer.set_user_cash"><function>stargazer.set_user_cash</function></link>,
+                <link linkend="stargazer.chg_user_tariff"><function>stargazer.chg_user_tariff</function></link>

                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>
                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>


@@ -774,25 +781,25 @@
                 <link linkend="stargazer.get_user"><function>stargazer.get_user</function></link>,
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.get_user"><function>stargazer.get_user</function></link>,
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,

-                <link linkend="stargazer.add_cash"><function>stargazer.add_cash</function></link>,
-                <link linkend="stargazer.set_cash"><function>stargazer.set_cash</function></link>,
-                <link linkend="stargazer.change_tariff"><function>stargazer.change_tariff</function></link>
+                <link linkend="stargazer.add_user_cash"><function>stargazer.add_user_cash</function></link>,
+                <link linkend="stargazer.set_user_cash"><function>stargazer.set_user_cash</function></link>,
+                <link linkend="stargazer.chg_user_tariff"><function>stargazer.chg_user_tariff</function></link>

                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>
     </refentry>
                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>
     </refentry>

-    <refentry id="stargazer.add_cash">
+    <refentry id="stargazer.add_user_cash">

         <refmeta>
         <refmeta>

-            <refentrytitle>stargazer.add_cash</refentrytitle>
+            <refentrytitle>stargazer.add_user_cash</refentrytitle>

         </refmeta>
         <refnamediv>
         </refmeta>
         <refnamediv>

-            <refname>stargazer.add_cash</refname>
+            <refname>stargazer.add_user_cash</refname>

             <refpurpose>Добавление денег на счет пользователя</refpurpose>
         </refnamediv>
         <refsynopsisdiv>
             <funcsynopsis>
                 <funcprototype>
             <refpurpose>Добавление денег на счет пользователя</refpurpose>
         </refnamediv>
         <refsynopsisdiv>
             <funcsynopsis>
                 <funcprototype>

-                    <funcdef><function>stargazer.add_cash</function></funcdef>
+                    <funcdef><function>stargazer.add_user_cash</function></funcdef>

                     <paramdef>string <parameter>cookie</parameter></paramdef>
                     <paramdef>string <parameter>login</parameter></paramdef>
                     <paramdef>double <parameter>amount</parameter></paramdef>
                     <paramdef>string <parameter>cookie</parameter></paramdef>
                     <paramdef>string <parameter>login</parameter></paramdef>
                     <paramdef>double <parameter>amount</parameter></paramdef>


@@ -802,7 +809,7 @@
         </refsynopsisdiv>
         <refsect1>
             <title>Description</title>
         </refsynopsisdiv>
         <refsect1>
             <title>Description</title>

-            <para>Метод <function>stargazer.add_cash</function> позволяет добавить деньги на счет указанного пользователя.</para>
+            <para>Метод <function>stargazer.add_user_cash</function> позволяет добавить деньги на счет указанного пользователя.</para>

             <variablelist>
                 <varlistentry>
                     <term>string <parameter>cookie</parameter></term>
             <variablelist>
                 <varlistentry>
                     <term>string <parameter>cookie</parameter></term>


@@ -842,24 +849,24 @@
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,

-                <link linkend="stargazer.set_cash"><function>stargazer.set_cash</function></link>,
-                <link linkend="stargazer.change_tariff"><function>stargazer.change_tariff</function></link>
+                <link linkend="stargazer.set_user_cash"><function>stargazer.set_user_cash</function></link>,
+                <link linkend="stargazer.chg_user_tariff"><function>stargazer.chg_user_tariff</function></link>

                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>
     </refentry>
                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>
     </refentry>

-    <refentry id="stargazer.set_cash">
+    <refentry id="stargazer.set_user_cash">

         <refmeta>
         <refmeta>

-            <refentrytitle>stargazer.set_cash</refentrytitle>
+            <refentrytitle>stargazer.set_user_cash</refentrytitle>

         </refmeta>
         <refnamediv>
         </refmeta>
         <refnamediv>

-            <refname>stargazer.set_cash</refname>
+            <refname>stargazer.set_user_cash</refname>

             <refpurpose>Установка состояния счета пользователя</refpurpose>
         </refnamediv>
         <refsynopsisdiv>
             <funcsynopsis>
                 <funcprototype>
             <refpurpose>Установка состояния счета пользователя</refpurpose>
         </refnamediv>
         <refsynopsisdiv>
             <funcsynopsis>
                 <funcprototype>

-                    <funcdef><function>stargazer.set_cash</function></funcdef>
+                    <funcdef><function>stargazer.set_user_cash</function></funcdef>

                     <paramdef>string <parameter>cookie</parameter></paramdef>
                     <paramdef>string <parameter>login</parameter></paramdef>
                     <paramdef>double <parameter>cash</parameter></paramdef>
                     <paramdef>string <parameter>cookie</parameter></paramdef>
                     <paramdef>string <parameter>login</parameter></paramdef>
                     <paramdef>double <parameter>cash</parameter></paramdef>


@@ -869,7 +876,7 @@
         </refsynopsisdiv>
         <refsect1>
             <title>Description</title>
         </refsynopsisdiv>
         <refsect1>
             <title>Description</title>

-            <para>Метод <function>stargazer.set_cash</function> позволяет установить состояние счета пользователя.</para>
+            <para>Метод <function>stargazer.set_user_cash</function> позволяет установить состояние счета пользователя.</para>

             <variablelist>
                 <varlistentry>
                     <term>string <parameter>cookie</parameter></term>
             <variablelist>
                 <varlistentry>
                     <term>string <parameter>cookie</parameter></term>


@@ -909,24 +916,24 @@
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,

-                <link linkend="stargazer.add_cash"><function>stargazer.add_cash</function></link>,
-                <link linkend="stargazer.change_tariff"><function>stargazer.change_tariff</function></link>
+                <link linkend="stargazer.add_user_cash"><function>stargazer.add_user_cash</function></link>,
+                <link linkend="stargazer.chg_user_tariff"><function>stargazer.chg_user_tariff</function></link>

                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>
     </refentry>
                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>
     </refentry>

-    <refentry id="stargazer.change_tariff">
+    <refentry id="stargazer.chg_user_tariff">

         <refmeta>
         <refmeta>

-            <refentrytitle>stargazer.change_tariff</refentrytitle>
+            <refentrytitle>stargazer.chg_user_tariff</refentrytitle>

         </refmeta>
         <refnamediv>
         </refmeta>
         <refnamediv>

-            <refname>stargazer.change_tariff</refname>
+            <refname>stargazer.chg_user_tariff</refname>

             <refpurpose>Изменение тарифного плана пользователя</refpurpose>
         </refnamediv>
         <refsynopsisdiv>
             <funcsynopsis>
                 <funcprototype>
             <refpurpose>Изменение тарифного плана пользователя</refpurpose>
         </refnamediv>
         <refsynopsisdiv>
             <funcsynopsis>
                 <funcprototype>

-                    <funcdef><function>stargazer.change_tariff</function></funcdef>
+                    <funcdef><function>stargazer.chg_user_tariff</function></funcdef>

                     <paramdef>string <parameter>cookie</parameter></paramdef>
                     <paramdef>string <parameter>login</parameter></paramdef>
                     <paramdef>string <parameter>tariff</parameter></paramdef>
                     <paramdef>string <parameter>cookie</parameter></paramdef>
                     <paramdef>string <parameter>login</parameter></paramdef>
                     <paramdef>string <parameter>tariff</parameter></paramdef>


@@ -937,7 +944,7 @@
         </refsynopsisdiv>
         <refsect1>
             <title>Description</title>
         </refsynopsisdiv>
         <refsect1>
             <title>Description</title>

-            <para>Метод <function>stargazer.change_tariff</function> позволяет изменить тарифный план пользователя или запланировать его изменение на начало нового месяца.</para>
+            <para>Метод <function>stargazer.chg_user_tariff</function> позволяет изменить тарифный план пользователя или запланировать его изменение на начало нового месяца.</para>

             <variablelist>
                 <varlistentry>
                     <term>string <parameter>cookie</parameter></term>
             <variablelist>
                 <varlistentry>
                     <term>string <parameter>cookie</parameter></term>


@@ -983,8 +990,8 @@
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,

-                <link linkend="stargazer.add_cash"><function>stargazer.add_cash</function></link>,
-                <link linkend="stargazer.set_cash"><function>stargazer.set_cash</function></link>
+                <link linkend="stargazer.add_user_cash"><function>stargazer.add_user_cash</function></link>,
+                <link linkend="stargazer.set_user_cash"><function>stargazer.set_user_cash</function></link>

                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>
                 <link linkend="stargazer.get_online_ips"><function>stargazer.get_online_ips</function></link>
             </para>
         </refsect1>


@@ -1050,11 +1057,10 @@
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,
                 <link linkend="stargazer.add_user"><function>stargazer.add_user</function></link>,
                 <link linkend="stargazer.chg_user"><function>stargazer.chg_user</function></link>,
                 <link linkend="stargazer.del_user"><function>stargazer.del_user</function></link>,

-                <link linkend="stargazer.add_cash"><function>stargazer.add_cash</function></link>,
-                <link linkend="stargazer.set_cash"><function>stargazer.set_cash</function></link>
-                <link linkend="stargazer.change_tariff"><function>stargazer.change_tariff</function></link>
+                <link linkend="stargazer.add_user_cash"><function>stargazer.add_user_cash</function></link>,
+                <link linkend="stargazer.set_user_cash"><function>stargazer.set_user_cash</function></link>
+                <link linkend="stargazer.chg_user_tariff"><function>stargazer.chg_user_tariff</function></link>

             </para>
         </refsect1>
     </refentry>
 </chapter>
             </para>
         </refsect1>
     </refentry>
 </chapter>

-