report.json

{
  "openrpc": "1.2.1",
  "info": {
    "title": "IBSng: branch E: report",
    "version": "1.0.0"
  },
  "methods": [
    {
      "name": "report.getOnlineUsers",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE ONLINE USERS"],
      "params": [
        {
          "name": "normal_sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "user_id",
              "normal_username",
              "login_time_epoch",
              "duration_secs",
              "ras_description",
              "ras_ip",
              "isp_name",
              "unique_id_val",
              "current_credit",
              "group_name",
              "attrs_remote_ip",
              "in_bytes",
              "out_bytes",
              "in_rate",
              "out_rate",
              "attrs_mac",
              "attrs_station_ip",
              "attrs_caller_id"
            ]
          }
        },
        {
          "name": "normal_desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        },
        {
          "name": "voip_sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "user_id",
              "voip_username",
              "login_time_epoch",
              "duration_secs",
              "ras_ip",
              "ras_description",
              "isp_name",
              "unique_id_val",
              "current_credit",
              "called_number",
              "prefix_name",
              "group_name",
              "attrs_caller_id",
              "attrs_caller_ip",
              "attrs_called_ip",
              "voip_provider"
            ]
          }
        },
        {
          "name": "voip_desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        },
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "dnis": {
                "title": "",
                "type": "string",
                "required": false
              },
              "isp_ids": {
                "title": "",
                "type": "array",
                "required": false
              },
              "isp_names": {
                "title": "",
                "type": "array",
                "required": false
              },
              "ras_ips": {
                "title": "",
                "type": "array",
                "required": false
              },
              "remote_ip": {
                "title": "",
                "type": "string",
                "required": false
              },
              "username_starts_with": {
                "title": "Array('A', 'B', 'C'), is like 'ABC'",
                "type": ["array", "string"],
                "required": false
              }
            }
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "report.getOnlineUsersCountLoop",
      "description": "with conditions (filters)",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE ONLINE USERS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as getOnlineUsers",
          "schema": {
            "type": "object",
            "properties": {}
          },
          "required": false
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "internet_onlines": {
              "title": "",
              "type": "integer"
            },
            "voip_onlines": {
              "title": "",
              "type": "integer"
            },
            "re_onlined": {
              "title": "",
              "type": "integer"
            },
            "accounting_not_started": {
              "title": "",
              "type": "integer"
            },
            "failed_users": {
              "title": "",
              "type": "integer"
            },
            "idle_users": {
              "title": "",
              "type": "integer"
            },
            "ras_acct_not_started": {
              "title": "dict of ras_desc => count",
              "type": "object",
              "additionalProperties": {
                "title": "ras_desc",
                "type": "str",
                "schema": {
                  "description": "count",
                  "type": "integer"
                }
              },
              "properties": {}
            },
            "ras_description": {
              "title": "dict of ras_desc => count",
              "type": "object",
              "additionalProperties": {
                "title": "ras_desc",
                "type": "str",
                "schema": {
                  "description": "count",
                  "type": "integer"
                }
              },
              "properties": {}
            },
            "ras_counters": {
              "title": "dict of ras_desc => count_dict",
              "type": "object",
              "additionalProperties": {
                "title": "Ras ID",
                "type": "str",
                "schema": {
                  "description": "a dict containing per-state user count",
                  "type": "object",
                  "properties": {
                    "ras_total": {
                      "title": "total number of onlines in this ras",
                      "type": "integer"
                    },
                    "ras_reonlined": {
                      "title": "number of re-onlined users in this ras",
                      "type": "integer"
                    },
                    "ras_failed": {
                      "title": "number of failed users in this ras",
                      "type": "integer"
                    },
                    "ras_acct_not_started": {
                      "title": "number of onlines users with Accounting Not Started status in this ras",
                      "type": "integer"
                    },
                    "ras_idle": {
                      "title": "number of Idle users in this ras",
                      "type": "integer"
                    }
                  }
                }
              },
              "properties": {}
            },
            "group_name": {
              "title": "a dict of group_name => count",
              "type": "object",
              "properties": {}
            },
            "isp_name": {
              "title": "a dict of isp_name => count",
              "type": "object",
              "properties": {}
            }
          }
        }
      }
    },
    {
      "name": "report.getOnlineUsersCount",
      "description": "without conditions",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE ONLINE USERS"],
      "params": [],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "internet_onlines": {
              "title": "",
              "type": "integer"
            },
            "voip_onlines": {
              "title": "",
              "type": "integer"
            },
            "re_onlined": {
              "title": "",
              "type": "integer"
            },
            "accounting_not_started": {
              "title": "",
              "type": "integer"
            },
            "failed_users": {
              "title": "",
              "type": "integer"
            },
            "idle_users": {
              "title": "",
              "type": "integer"
            },
            "ras_acct_not_started": {
              "title": "dict of ras_desc => count",
              "type": "object",
              "additionalProperties": {
                "title": "ras_desc",
                "type": "str",
                "schema": {
                  "description": "count",
                  "type": "integer"
                }
              },
              "properties": {}
            },
            "ras_description": {
              "title": "dict of ras_desc => count",
              "type": "object",
              "additionalProperties": {
                "title": "ras_desc",
                "type": "str",
                "schema": {
                  "description": "count",
                  "type": "integer"
                }
              },
              "properties": {}
            },
            "ras_counters": {
              "title": "dict of ras_desc => count_dict",
              "type": "object",
              "additionalProperties": {
                "title": "Ras ID",
                "type": "str",
                "schema": {
                  "description": "a dict containing per-state user count",
                  "type": "object",
                  "properties": {
                    "ras_total": {
                      "title": "total number of onlines in this ras",
                      "type": "integer"
                    },
                    "ras_reonlined": {
                      "title": "number of re-onlined users in this ras",
                      "type": "integer"
                    },
                    "ras_failed": {
                      "title": "number of failed users in this ras",
                      "type": "integer"
                    },
                    "ras_acct_not_started": {
                      "title": "number of onlines users with Accounting Not Started status in this ras",
                      "type": "integer"
                    },
                    "ras_idle": {
                      "title": "number of Idle users in this ras",
                      "type": "integer"
                    }
                  }
                }
              },
              "properties": {}
            },
            "group_name": {
              "title": "a dict of group_name => count",
              "type": "object",
              "properties": {}
            },
            "isp_name": {
              "title": "a dict of isp_name => count",
              "type": "object",
              "properties": {}
            }
          }
        }
      }
    },
    {
      "name": "report.getOnlineUsersCountPerISP",
      "description": "without conditions",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE ONLINE USERS"],
      "params": [],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "onlines_per_isp": {
              "title": "a dict of isp_id => count",
              "type": "object",
              "properties": {}
            }
          }
        }
      }
    },
    {
      "name": "report.getConnections",
      "description": "Get Connection Logs By Admin",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "user_ids": {
                "title": "",
                "type": "string",
                "required": false
              },
              "connection_username": {
                "title": "internet username",
                "type": "string",
                "required": false
              },
              "connection_voip_username": {
                "title": "voip username",
                "type": "string",
                "required": false
              },
              "not_username": {
                "title": "",
                "type": "string",
                "required": false
              },
              "username": {
                "title": "",
                "type": "string",
                "required": false
              },
              "voip_username": {
                "title": "",
                "type": "string",
                "required": false
              },
              "serial": {
                "title": "",
                "type": "string",
                "required": false
              },
              "sub_service_name": {
                "title": "subservice name",
                "type": "string",
                "required": false
              },
              "sub_service_charging": {
                "title": "subservice charging",
                "type": "string",
                "required": false
              },
              "isp_names": {
                "title": "",
                "type": "string",
                "required": false
              },
              "credit_used": {
                "title": "",
                "type": "number",
                "required": false
              },
              "credit_used_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "duration": {
                "title": "in seconds",
                "type": "integer",
                "required": false
              },
              "duration_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "login_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "login_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "login_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "login_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "logout_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "logout_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "logout_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "logout_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "show_total_credit_used": {
                "title": "if initialize with 'on' in result returns total credit used",
                "type": "string",
                "required": false
              },
              "show_total_inouts": {
                "title": "if initialize with 'on' in result returns total download and upload",
                "type": "string",
                "required": false
              },
              "successful": {
                "title": "",
                "type": "string",
                "enum": ["yes", "no"]
              },
              "service": {
                "title": "",
                "type": "string",
                "enum": ["Internet", "VoIP"]
              },
              "ras_ip": {
                "title": "",
                "type": "string",
                "required": false
              },
              "ras_desc": {
                "title": "",
                "type": "string",
                "required": false
              },
              "group_name": {
                "title": "",
                "type": "string",
                "required": false
              },
              "exclude_isp_mapped_users": {
                "title": "true if exists, ",
                "type": "boolean",
                "required": false
              },
              "caller_id": {
                "title": "",
                "type": "string",
                "required": false
              },
              "caller_id_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "mac": {
                "title": "",
                "type": "string",
                "required": false
              },
              "port": {
                "title": "",
                "type": "string",
                "required": false
              },
              "dnis": {
                "title": "",
                "type": "string",
                "required": false
              },
              "assigned_ip": {
                "title": "",
                "type": "string",
                "required": false
              },
              "station_ip": {
                "title": "",
                "type": "string",
                "required": false
              },
              "cpm": {
                "title": "",
                "type": "number",
                "required": false
              },
              "cpm_op": {
                "title": "comes with cpm",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "called_number": {
                "title": "",
                "type": "string",
                "required": false
              },
              "called_number_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "prefix_name": {
                "title": "",
                "type": "string",
                "required": false
              },
              "prefix_name_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "called_ip": {
                "title": "",
                "type": "string",
                "required": false
              },
              "voip_provider_names": {
                "title": "list of provider names, or string of one provider name",
                "type": ["array", "string"],
                "required": false
              },
              "remote_ip": {
                "title": "",
                "type": "string",
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "user_id",
              "credit_used",
              "login_time",
              "logout_time",
              "successful",
              "service",
              "ras_id",
              "connection_log_id"
            ]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "number of total rows",
              "type": "integer"
            },
            "total_credit": {
              "title": "sum of total rows credit",
              "type": "number"
            },
            "total_duration": {
              "title": "sum of total rows duration, in seconds",
              "type": "integer"
            },
            "total_in_bytes": {
              "title": "sum of total download, in bytes",
              "type": "integer"
            },
            "total_out_bytes": {
              "title": "sum of total upload, in bytes",
              "type": "integer"
            },
            "report": {
              "title": "report data of specified page (from - to)",
              "type": "array",
              "items": {
                "title": "",
                "type": "object",
                "properties": {
                  "connection_log_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "user_id": {
                    "title": "",
                    "type": "string"
                  },
                  "service_type": {
                    "title": "",
                    "type": "string",
                    "enum": ["Internet", "VoIP"]
                  },
                  "login_time_formatted": {
                    "title": "datetime, ",
                    "type": "string",
                    "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$"
                  },
                  "logout_time_formatted": {
                    "title": "datetime, ",
                    "type": "string",
                    "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$"
                  },
                  "duration_seconds": {
                    "title": "",
                    "type": "integer"
                  },
                  "credit_used": {
                    "title": "",
                    "type": "number"
                  },
                  "before_credit": {
                    "title": "",
                    "type": "number"
                  },
                  "successful": {
                    "title": "",
                    "type": "boolean"
                  },
                  "caller_id": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "cpm": {
                    "title": "",
                    "type": "number",
                    "required": false
                  },
                  "persistent_lan": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "kill_reason": {
                    "title": "",
                    "type": "string"
                  },
                  "username": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "remote_ip": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "mac": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "bytes_in": {
                    "title": "",
                    "type": "integer",
                    "required": false
                  },
                  "bytes_out": {
                    "title": "",
                    "type": "integer",
                    "required": false
                  },
                  "station_ip": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "details": {
                    "title": "",
                    "type": "array"
                  },
                  "voip_username": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "prefix_name": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "prefix_cpm": {
                    "title": "",
                    "type": "number",
                    "required": false
                  },
                  "called_number": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "charge_rule_details": {
                    "title": "",
                    "type": "array"
                  },
                  "ras_description": {
                    "title": "",
                    "type": "string"
                  },
                  "ras_ip": {
                    "title": "",
                    "type": "string"
                  },
                  "serial": {
                    "title": "",
                    "type": "string"
                  },
                  "dnis": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "called_ip": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "prefix_code": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "voip_provider_id": {
                    "title": "",
                    "type": "integer",
                    "required": false
                  },
                  "voip_provider": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "voip_provider_ip": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "voip_provider_credit_used": {
                    "title": "",
                    "type": "number",
                    "required": false
                  },
                  "voip_provider_prefix_name": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "voip_provider_prefix_code": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "voip_provider_cpm": {
                    "title": "",
                    "type": "number",
                    "required": false
                  },
                  "disconnect_cause": {
                    "title": "",
                    "type": "string",
                    "required": false
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getConnections",
      "description": "Get Connection Logs By Admin",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "credit_used": {
                "title": "",
                "type": "number",
                "required": false
              },
              "credit_used_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "duration": {
                "title": "in seconds",
                "type": "integer",
                "required": false
              },
              "duration_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "login_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "login_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "login_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "login_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "logout_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "logout_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "logout_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "logout_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "successful": {
                "title": "",
                "type": "string",
                "enum": ["yes", "no"]
              },
              "service": {
                "title": "",
                "type": "string",
                "enum": ["Internet", "VoIP"]
              },
              "ras_ip": {
                "title": "",
                "type": "string",
                "required": false
              },
              "ras_desc": {
                "title": "",
                "type": "string",
                "required": false
              },
              "caller_id": {
                "title": "",
                "type": "string",
                "required": false
              },
              "caller_id_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "mac": {
                "title": "",
                "type": "string",
                "required": false
              },
              "port": {
                "title": "",
                "type": "string",
                "required": false
              },
              "dnis": {
                "title": "",
                "type": "string",
                "required": false
              },
              "assigned_ip": {
                "title": "",
                "type": "string",
                "required": false
              },
              "station_ip": {
                "title": "",
                "type": "string",
                "required": false
              },
              "cpm": {
                "title": "",
                "type": "number",
                "required": false
              },
              "cpm_op": {
                "title": "comes with cpm",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "called_number": {
                "title": "",
                "type": "string",
                "required": false
              },
              "called_number_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "prefix_name": {
                "title": "",
                "type": "string",
                "required": false
              },
              "prefix_name_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "called_ip": {
                "title": "",
                "type": "string",
                "required": false
              },
              "voip_provider_names": {
                "title": "list of provider names, or string of one provider name",
                "type": ["array", "string"],
                "required": false
              },
              "remote_ip": {
                "title": "",
                "type": "string",
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "credit_used",
              "login_time",
              "logout_time",
              "successful",
              "service",
              "ras_id",
              "connection_log_id"
            ]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "number of total rows",
              "type": "integer"
            },
            "total_credit": {
              "title": "sum of total rows credit",
              "type": "number"
            },
            "total_duration": {
              "title": "sum of total rows duration, in seconds",
              "type": "integer"
            },
            "total_in_bytes": {
              "title": "sum of total download, in bytes",
              "type": "integer"
            },
            "total_out_bytes": {
              "title": "sum of total upload, in bytes",
              "type": "integer"
            },
            "report": {
              "title": "report data of specified page (from - to)",
              "type": "array",
              "items": {
                "title": "",
                "type": "object",
                "properties": {
                  "connection_log_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "user_id": {
                    "title": "",
                    "type": "string"
                  },
                  "service_type": {
                    "title": "",
                    "type": "string",
                    "enum": ["Internet", "VoIP"]
                  },
                  "login_time_formatted": {
                    "title": "datetime, ",
                    "type": "string",
                    "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$"
                  },
                  "logout_time_formatted": {
                    "title": "datetime, ",
                    "type": "string",
                    "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$"
                  },
                  "duration_seconds": {
                    "title": "",
                    "type": "integer"
                  },
                  "credit_used": {
                    "title": "",
                    "type": "number"
                  },
                  "before_credit": {
                    "title": "",
                    "type": "number"
                  },
                  "successful": {
                    "title": "",
                    "type": "boolean"
                  },
                  "caller_id": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "cpm": {
                    "title": "",
                    "type": "number",
                    "required": false
                  },
                  "persistent_lan": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "kill_reason": {
                    "title": "",
                    "type": "string"
                  },
                  "username": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "remote_ip": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "mac": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "bytes_in": {
                    "title": "",
                    "type": "integer",
                    "required": false
                  },
                  "bytes_out": {
                    "title": "",
                    "type": "integer",
                    "required": false
                  },
                  "station_ip": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "details": {
                    "title": "",
                    "type": "array"
                  },
                  "voip_username": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "prefix_name": {
                    "title": "",
                    "type": "string",
                    "required": false
                  },
                  "prefix_cpm": {
                    "title": "",
                    "type": "number",
                    "required": false
                  },
                  "called_number": {
                    "title": "",
                    "type": "string",
                    "required": false
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getINConnections",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method, plus caller_id",
          "schema": {
            "type": "object",
            "properties": {
              "caller_id": {
                "title": "",
                "type": "string",
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "credit_used",
              "login_time",
              "logout_time",
              "successful",
              "service",
              "ras_id",
              "connection_log_id"
            ]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "the same as 'report.getConnections' method",
        "schema": {
          "title": "",
          "type": "object"
        }
      }
    },
    {
      "name": "report.getDurations",
      "description": "",
      "auth_type": ["ADMIN", "NORMAL_USER", "VOIP_USER"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "report.getGroupUsages",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "report.getRasUsages",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "report.getVoIPDisconnectCauses",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "report.getSuccessfulCounts",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "report.getISPUsages",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "report.getInOutUsages",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["creation_date", "normal_username", "sum"]
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "Number of total rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "array"
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getCreditUsages",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["creation_date", "normal_username", "sum"]
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "Number of total rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "array"
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getDurationUsages",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["creation_date", "normal_username", "sum"]
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "Number of total rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "array"
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getConnectionUsages",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "total_credit",
              "total_duration",
              "total_in_bytes",
              "total_out_bytes"
            ]
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "Number of total rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "object",
                "properties": {
                  "user_id": {
                    "title": "User ID",
                    "type": "integer"
                  },
                  "username": {
                    "title": "User username",
                    "type": "string"
                  },
                  "serial": {
                    "title": "User serial",
                    "type": "string"
                  },
                  "group_name": {
                    "title": "User group name",
                    "type": "string"
                  },
                  "isp_name": {
                    "title": "User ISP name",
                    "type": "string"
                  },
                  "creation_date": {
                    "title": "User creation date",
                    "type": "string"
                  },
                  "name": {
                    "title": "Name of user",
                    "type": "string"
                  },
                  "sub_service_name": {
                    "title": "Sub service name",
                    "type": "string"
                  },
                  "sub_service_charging": {
                    "title": "Sub service charging name",
                    "type": "string"
                  },
                  "seb_service_qos": {
                    "title": "Sub service QOS name",
                    "type": "string"
                  },
                  "total_credit": {
                    "title": "Total credit",
                    "type": "integer"
                  },
                  "total_duration": {
                    "title": "Total duration",
                    "type": "integer"
                  },
                  "total_in_bytes": {
                    "title": "Total in bytes",
                    "type": "integer"
                  },
                  "total_out_bytes": {
                    "title": "Total out bytes",
                    "type": "integer"
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getExpiredUsers",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as user.searchUser",
          "schema": {
            "type": "object",
            "properties": {}
          }
        },
        {
          "name": "from",
          "description": "start index",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": {
              "user_id": "",
              "normal_username": "",
              "voip_username": "",
              "group_id": "",
              "owner_id": "owner isp id",
              "creation_date": "",
              "credit": "",
              "deposit": "",
              "first_login": "",
              "serial": "",
              "serial_numeric": ""
            }
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "report.getPrefixNameUsage",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {
              "group_by": {
                "title": "",
                "type": "array",
                "items": {
                  "title": "",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "prefix_name",
                      "prefix_code",
                      "cpm",
                      "voip_provider_id",
                      "voip_provider_prefix_code",
                      "voip_provider_prefix_name"
                    ]
                  }
                },
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "prefix_name",
              "prefix_code",
              "duration_sum",
              "count",
              "credit"
            ]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "total number of rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "array"
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getCallerIDUsages",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["creation_date", "normal_username", "sum"]
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "Number of total rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "array"
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getCreditChanges",
      "description": "Admin-View Credit Changes",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CREDIT CHANGES"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "user_ids": {
                "title": "",
                "type": "string",
                "required": false
              },
              "voip_username": {
                "title": "",
                "type": "string",
                "required": false
              },
              "admin": {
                "title": "admin username",
                "type": "string",
                "required": false
              },
              "action": {
                "title": "",
                "type": "array",
                "items": {
                  "title": "",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "ADD_USER",
                      "CHANGE_CREDIT",
                      "DEL_USER",
                      "RELATIVE_PERIODIC_CHANGE_CREDIT",
                      "ABSOLUTE_PERIODIC_CHANGE_CREDIT",
                      "RENEW_TRASH_REMAINING",
                      "RENEW",
                      "CREDIT_TRANSFER",
                      "RECEIVE_CREDIT_TRANSFER",
                      "ONLINE_PAYMENT",
                      "AUTO_RENEW",
                      "RECHARGE",
                      "AUTO_RECHARGE",
                      "TEMPORARY_EXTEND",
                      "TEMPORARY_EXTEND_TRASH_REMAINING",
                      "EXTRA_CHARGE",
                      "VOUCHER"
                    ]
                  }
                },
                "required": false
              },
              "per_user_credit": {
                "title": "",
                "type": "number",
                "required": false
              },
              "per_user_credit_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "isp_credit": {
                "title": "",
                "type": "number",
                "required": false
              },
              "isp_credit_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "change_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "change_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "remote_addr": {
                "title": "",
                "type": "string",
                "required": false
              },
              "comment": {
                "title": "",
                "type": "string",
                "required": false
              },
              "deleted_internet_username": {
                "title": "internet username that is deleted",
                "type": "string",
                "required": false
              },
              "deleted_voip_username": {
                "title": "voip username that is deleted",
                "type": "string",
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["change_time", "per_user_credit", "isp_credit"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "Number of total rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "array"
              }
            },
            "total_per_user_credit": {
              "title": "",
              "type": "number"
            },
            "total_admin_credit": {
              "title": "",
              "type": "number"
            }
          }
        }
      }
    },
    {
      "name": "report.getCreditChanges",
      "description": "User-View Credit Changes",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CREDIT CHANGES"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "user_view": {
                "title": "Key must be present for User-view",
                "type": "",
                "required": false
              },
              "user_ids": {
                "title": "",
                "type": "string",
                "required": false
              },
              "voip_username": {
                "title": "",
                "type": "string",
                "required": false
              },
              "admin": {
                "title": "admin username",
                "type": "string",
                "required": false
              },
              "action": {
                "title": "",
                "type": "array",
                "items": {
                  "title": "",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "ADD_USER",
                      "CHANGE_CREDIT",
                      "DEL_USER",
                      "RELATIVE_PERIODIC_CHANGE_CREDIT",
                      "ABSOLUTE_PERIODIC_CHANGE_CREDIT",
                      "RENEW_TRASH_REMAINING",
                      "RENEW",
                      "CREDIT_TRANSFER",
                      "RECEIVE_CREDIT_TRANSFER",
                      "ONLINE_PAYMENT",
                      "AUTO_RENEW",
                      "RECHARGE",
                      "AUTO_RECHARGE",
                      "TEMPORARY_EXTEND",
                      "TEMPORARY_EXTEND_TRASH_REMAINING",
                      "EXTRA_CHARGE",
                      "VOUCHER"
                    ]
                  }
                },
                "required": false
              },
              "per_user_credit": {
                "title": "",
                "type": "number",
                "required": false
              },
              "per_user_credit_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "isp_credit": {
                "title": "",
                "type": "number",
                "required": false
              },
              "isp_credit_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "change_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "change_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "remote_addr": {
                "title": "",
                "type": "string",
                "required": false
              },
              "comment": {
                "title": "",
                "type": "string",
                "required": false
              },
              "deleted_internet_username": {
                "title": "internet username that is deleted",
                "type": "string",
                "required": false
              },
              "deleted_voip_username": {
                "title": "voip username that is deleted",
                "type": "string",
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["change_time", "per_user_credit", "isp_credit"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "Number of total rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "array"
              }
            },
            "total_per_user_credit": {
              "title": "",
              "type": "number"
            },
            "total_admin_credit": {
              "title": "",
              "type": "number"
            }
          }
        }
      }
    },
    {
      "name": "report.getCreditChanges",
      "description": "User-View Credit Changes by User",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "requires_perm": ["SEE CREDIT CHANGES"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "user_view": {
                "title": "Key must be present for User-view",
                "type": "",
                "required": false
              },
              "action": {
                "title": "",
                "type": "array",
                "items": {
                  "title": "",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "ADD_USER",
                      "CHANGE_CREDIT",
                      "DEL_USER",
                      "RELATIVE_PERIODIC_CHANGE_CREDIT",
                      "ABSOLUTE_PERIODIC_CHANGE_CREDIT",
                      "RENEW_TRASH_REMAINING",
                      "RENEW",
                      "CREDIT_TRANSFER",
                      "RECEIVE_CREDIT_TRANSFER",
                      "ONLINE_PAYMENT",
                      "AUTO_RENEW",
                      "RECHARGE",
                      "AUTO_RECHARGE",
                      "TEMPORARY_EXTEND",
                      "TEMPORARY_EXTEND_TRASH_REMAINING",
                      "EXTRA_CHARGE",
                      "VOUCHER"
                    ]
                  }
                },
                "required": false
              },
              "per_user_credit": {
                "title": "",
                "type": "number",
                "required": false
              },
              "per_user_credit_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "change_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "change_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "remote_addr": {
                "title": "",
                "type": "string",
                "required": false
              },
              "comment": {
                "title": "",
                "type": "string",
                "required": false
              },
              "deleted_internet_username": {
                "title": "internet username that is deleted",
                "type": "string",
                "required": false
              },
              "deleted_voip_username": {
                "title": "voip username that is deleted",
                "type": "string",
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["change_time", "per_user_credit"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "Number of total rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "array"
              }
            },
            "total_per_user_credit": {
              "title": "",
              "type": "number"
            },
            "total_isp_credit": {
              "title": "",
              "type": "number"
            }
          }
        }
      }
    },
    {
      "name": "report.saveCreditChanges",
      "description": "use SystemNotification.getNotifications() method to see if the report is finished         and get the URL to download it",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CREDIT CHANGES"],
      "params": [
        {
          "name": "conds",
          "description": "the same as getCreditChanges",
          "schema": {
            "type": "object",
            "properties": {}
          }
        },
        {
          "name": "cols",
          "description": "",
          "schema": {
            "type": "array",
            "items": {
              "title": "",
              "schema": {
                "type": "string",
                "enum": {
                  "action": "",
                  "action_text": "",
                  "admin_id": "",
                  "admin_name": "",
                  "change_time": "",
                  "change_time_formatted": "",
                  "comment": "",
                  "credit_change_id": "",
                  "isp_credit": "",
                  "isp_id": "",
                  "isp_name": "",
                  "per_user_credit": "",
                  "remote_addr": "",
                  "user_id": "in user_view mode only",
                  "username": "in user_view mode only",
                  "name": "in user_view mode only",
                  "serial": "in user_view mode only",
                  "group": "in user_view mode only",
                  "group_id": "in user_view mode only",
                  "before_credit": "in user_view mode only",
                  "user_ids": "in admin-view only (no user_view in conds) "
                }
              }
            }
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["change_time", "per_user_credit", "isp_credit"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        },
        {
          "name": "output_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["csv", "pdf"]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "report.getUserDepositChanges",
      "description": "by admin",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE USER DEPOSIT CHANGES"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "user_ids": {
                "title": "",
                "type": "string",
                "required": false
              },
              "admin": {
                "title": "list of admin usernames, or string of one admin username",
                "type": ["array", "string"],
                "required": false
              },
              "action": {
                "title": "",
                "type": "array",
                "items": {
                  "title": "",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "ADD_USER",
                      "CHANGE_DEPOSIT",
                      "DEL_USER",
                      "ONLINE_PAYMENT",
                      "DEPOSIT_TRANSFER",
                      "AUTO_RENEW",
                      "RECEIVE_DEPOSIT_TRANSFER",
                      "AUTO_RECHARGE",
                      "EXTRA_CHARGE",
                      "VOUCHER"
                    ]
                  }
                },
                "required": false
              },
              "deposit": {
                "title": "comes with deposit_op cond",
                "type": "number",
                "required": false
              },
              "deposit_op": {
                "title": "comes with deposit cond",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "change_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "change_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "remote_addr": {
                "title": "",
                "type": "string",
                "required": false
              },
              "group_name": {
                "title": "list of group names, or string of one group name",
                "type": ["array", "string"],
                "required": false
              },
              "user_isp_names": {
                "title": "list of isp names, or string one isp name",
                "type": ["array", "string"],
                "required": false
              },
              "isp_names": {
                "title": "list of isp names, or string one isp name",
                "type": ["array", "string"],
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["change_time", "user_id", "deposit_change"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "",
              "type": "integer"
            },
            "total_deposit": {
              "title": "",
              "type": "number"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "object",
                "properties": {
                  "action": {
                    "title": "1 to 10",
                    "type": "integer"
                  },
                  "action_text": {
                    "title": "",
                    "type": "string",
                    "enum": [
                      "ADD_USER",
                      "CHANGE_DEPOSIT",
                      "DEL_USER",
                      "ONLINE_PAYMENT",
                      "DEPOSIT_TRANSFER",
                      "AUTO_RENEW",
                      "RECEIVE_DEPOSIT_TRANSFER",
                      "AUTO_RECHARGE",
                      "EXTRA_CHARGE",
                      "VOUCHER"
                    ]
                  },
                  "admin_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "admin_name": {
                    "title": "",
                    "type": "string"
                  },
                  "change_time": {
                    "title": "gregorian",
                    "type": "string"
                  },
                  "change_time_formatted": {
                    "title": "depends on input date_type",
                    "type": "string"
                  },
                  "comment": {
                    "title": "",
                    "type": "string"
                  },
                  "deposit_change": {
                    "title": "",
                    "type": "number"
                  },
                  "deposit_change_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "group_name": {
                    "title": "",
                    "type": "string"
                  },
                  "isp_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "isp_name": {
                    "title": "",
                    "type": "string"
                  },
                  "remote_addr": {
                    "title": "Remote IP",
                    "type": "string"
                  },
                  "user_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "username": {
                    "title": "",
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getUserDepositChanges",
      "description": "by user",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "admin": {
                "title": "list of admin usernames, or string of one admin username",
                "type": ["array", "string"],
                "required": false
              },
              "action": {
                "title": "",
                "type": "array",
                "items": {
                  "title": "",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "ADD_USER",
                      "CHANGE_DEPOSIT",
                      "DEL_USER",
                      "ONLINE_PAYMENT",
                      "DEPOSIT_TRANSFER",
                      "AUTO_RENEW",
                      "RECEIVE_DEPOSIT_TRANSFER",
                      "AUTO_RECHARGE",
                      "EXTRA_CHARGE",
                      "VOUCHER"
                    ]
                  }
                },
                "required": false
              },
              "deposit": {
                "title": "comes with deposit_op cond",
                "type": "number",
                "required": false
              },
              "deposit_op": {
                "title": "comes with deposit cond",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "change_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "change_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "remote_addr": {
                "title": "",
                "type": "string",
                "required": false
              },
              "group_name": {
                "title": "list of group names, or string of one group name",
                "type": ["array", "string"],
                "required": false
              },
              "isp_names": {
                "title": "list of isp names, or string one isp name",
                "type": ["array", "string"],
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["change_time", "user_id", "deposit_change"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "",
              "type": "integer"
            },
            "total_deposit": {
              "title": "",
              "type": "number"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "object",
                "properties": {
                  "action": {
                    "title": "1 to 10",
                    "type": "integer"
                  },
                  "action_text": {
                    "title": "",
                    "type": "string",
                    "enum": [
                      "ADD_USER",
                      "CHANGE_DEPOSIT",
                      "DEL_USER",
                      "ONLINE_PAYMENT",
                      "DEPOSIT_TRANSFER",
                      "AUTO_RENEW",
                      "RECEIVE_DEPOSIT_TRANSFER",
                      "AUTO_RECHARGE",
                      "EXTRA_CHARGE",
                      "VOUCHER"
                    ]
                  },
                  "change_time": {
                    "title": "gregorian",
                    "type": "string"
                  },
                  "change_time_formatted": {
                    "title": "depends on input date_type",
                    "type": "string"
                  },
                  "comment": {
                    "title": "",
                    "type": "string"
                  },
                  "deposit_change": {
                    "title": "",
                    "type": "number"
                  },
                  "deposit_change_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "group_name": {
                    "title": "",
                    "type": "string"
                  },
                  "user_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "username": {
                    "title": "",
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getUserAuditLogs",
      "description": "",
      "auth_type": ["ADMIN"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "user_ids": {
                "title": "sets is_user=yes and turns on user-mode",
                "type": "string",
                "required": false
              },
              "user_isp_names": {
                "title": "sets is_user=yes and turns on user-mode",
                "type": "array",
                "required": false
              },
              "group_name": {
                "title": "sets is_user=no and turns on group-mode",
                "type": "array",
                "required": false
              },
              "attr_names": {
                "title": "",
                "type": "string",
                "required": false
              },
              "change_time_from": {
                "title": "",
                "type": "string",
                "required": false
              },
              "change_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "change_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "is_user": {
                "title": "",
                "type": "string",
                "enum": ["yes", "no"]
              },
              "isp_names": {
                "title": "list of isp names, or string of one isp name",
                "type": ["array", "string"],
                "required": false
              },
              "admin": {
                "title": "admin username",
                "type": "string",
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["change_time", "object_id", "admin_id"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "number of total rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "object",
                "properties": {
                  "admin_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "admin_name": {
                    "title": "",
                    "type": "string"
                  },
                  "attr_name": {
                    "title": "",
                    "type": "string"
                  },
                  "change_time": {
                    "title": "gregorian",
                    "type": "string"
                  },
                  "change_time_formatted": {
                    "title": "depending on input date_type",
                    "type": "string"
                  },
                  "is_user": {
                    "title": "",
                    "type": "string",
                    "enum": {
                      "t": "true / yes",
                      "f": "false / no"
                    }
                  },
                  "new_value": {
                    "title": "",
                    "type": "string"
                  },
                  "object_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "old_value": {
                    "title": "",
                    "type": "string"
                  },
                  "remote_ip": {
                    "title": "",
                    "type": "string"
                  },
                  "user_audit_log": {
                    "title": "log id",
                    "type": "integer"
                  },
                  "username": {
                    "title": "only exists in user-mode (is_user=yes)",
                    "type": "string",
                    "required": false
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getRequestCount",
      "description": "number of admin requests for each minute in the last hour",
      "auth_type": ["ADMIN"],
      "requires_perm": ["GOD"],
      "params": [],
      "result": {
        "name": "Response (object)",
        "summary": "a dict of timestamp (for each minute) to request_dict",
        "schema": {
          "title": "",
          "type": "object"
        }
      }
    },
    {
      "name": "report.getRequestTopStats",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["GOD"],
      "params": [
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["count", "average_duration", "total_duration"]
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "report.getISPDepositChangeLogs",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE DEPOSIT CHANGES"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "admin": {
                "title": "list of admin usernames, or string of one admin username",
                "type": ["array", "string"],
                "required": false
              },
              "admin_isp_name": {
                "title": "isp name of admin, list or string (of one)",
                "type": ["array", "string"],
                "required": false
              },
              "isp_names": {
                "title": "list of isp names, or string of one isp name",
                "type": ["array", "string"],
                "required": false
              },
              "change_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "change_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "isp_deposit_change_admin_id",
              "isp_deposit_change_isp_id",
              "isp_deposit_change_time",
              "isp_deposit_change_amount"
            ]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "number of total rows",
              "type": "integer"
            },
            "total_deposit_change": {
              "title": "total/sum of deposit change amounts",
              "type": "number"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "object",
                "properties": {
                  "isp_deposit_before_change": {
                    "title": "",
                    "type": "number"
                  },
                  "isp_deposit_change_action": {
                    "title": "",
                    "type": "string",
                    "enum": [
                      "ADD_ISP",
                      "CHANGE_ISP_DEPOSIT",
                      "DEL_ISP",
                      "PENALTY"
                    ]
                  },
                  "isp_deposit_change_admin_id": {
                    "title": "Admin ID",
                    "type": "integer"
                  },
                  "isp_deposit_change_admin_isp_id": {
                    "title": "Admin's Owner ISP ID",
                    "type": "integer"
                  },
                  "isp_deposit_change_admin_isp_name": {
                    "title": "Admin's Owner ISP Name",
                    "type": "string"
                  },
                  "isp_deposit_change_admin_name": {
                    "title": "Admin Username",
                    "type": "string"
                  },
                  "isp_deposit_change_amount": {
                    "title": "Changed Amount",
                    "type": "number"
                  },
                  "isp_deposit_change_comment": {
                    "title": "Comment",
                    "type": "string"
                  },
                  "isp_deposit_change_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "isp_deposit_change_isp_id": {
                    "title": "ISP ID",
                    "type": "integer"
                  },
                  "isp_deposit_change_isp_name": {
                    "title": "ISP Name",
                    "type": "string"
                  },
                  "isp_deposit_change_remote_addr": {
                    "title": "Admin's Remote IP",
                    "type": "string"
                  },
                  "isp_deposit_change_time": {
                    "title": "Change time, gregorian",
                    "type": "string"
                  },
                  "isp_deposit_change_time_formatted": {
                    "title": "datetime, Change time, depending on input date_type",
                    "type": "string",
                    "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$"
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getTemporaryExtendLogs",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["TEMPORARY EXTEND"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "isp_names": {
                "title": "list of isp names, or string of one isp name",
                "type": ["array", "string"],
                "required": false
              },
              "user_ids": {
                "title": "",
                "type": "string",
                "required": false
              },
              "temporary_extend_date_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "temporary_extend_date_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "temporary_extend_date_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "temporary_extend_date_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "temporary_extend_date",
              "user_id",
              "temporary_extend_hours",
              "credit_usage"
            ]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "number of total rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "object",
                "properties": {
                  "credit_usage": {
                    "title": "",
                    "type": "number"
                  },
                  "duration_seconds": {
                    "title": "",
                    "type": "integer"
                  },
                  "finish_date": {
                    "title": "",
                    "type": "string"
                  },
                  "finish_date_formatted": {
                    "title": "",
                    "type": "string"
                  },
                  "temporary_extend_credit": {
                    "title": "",
                    "type": "number"
                  },
                  "temporary_extend_date": {
                    "title": "",
                    "type": "string"
                  },
                  "temporary_extend_date_formatted": {
                    "title": "",
                    "type": "string"
                  },
                  "temporary_extend_hours": {
                    "title": "",
                    "type": "integer"
                  },
                  "temporary_extend_log_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "user_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "username": {
                    "title": "starts with 'I ' for internet users",
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "name": "report.delReports",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["DELETE REPORTS"],
      "params": [
        {
          "name": "table",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "date",
          "description": "datetime or number, ",
          "schema": {
            "type": ["string", "number"]
          }
        },
        {
          "name": "date_unit",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "jalali",
              "gregorian",
              "years",
              "months",
              "days",
              "hours",
              "minutes"
            ]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "report.autoCleanReports",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["DELETE REPORTS"],
      "params": [
        {
          "name": "connection_log_clean",
          "description": "period",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "connection_log_unit",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["Seconds", "Minutes", "Hours", "Days", "Months", "Years"]
          }
        },
        {
          "name": "credit_change_clean",
          "description": "relative time",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "credit_change_unit",
          "description": "relative time unit",
          "schema": {
            "type": "string",
            "enum": ["Seconds", "Minutes", "Hours", "Days", "Months", "Years"]
          }
        },
        {
          "name": "user_audit_log_clean",
          "description": "relative time",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "user_audit_log_unit",
          "description": "relative time unit",
          "schema": {
            "type": "string",
            "enum": ["Seconds", "Minutes", "Hours", "Days", "Months", "Years"]
          }
        },
        {
          "name": "snapshots_clean",
          "description": "relative time",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "snapshots_unit",
          "description": "relative time unit",
          "schema": {
            "type": "string",
            "enum": ["Seconds", "Minutes", "Hours", "Days", "Months", "Years"]
          }
        },
        {
          "name": "bw_snapshots_clean",
          "description": "relative time",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "bw_snapshots_unit",
          "description": "relative time unit",
          "schema": {
            "type": "string",
            "enum": ["Seconds", "Minutes", "Hours", "Days", "Months", "Years"]
          }
        },
        {
          "name": "web_analyzer_clean",
          "description": "relative time",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "web_analyzer_unit",
          "description": "relative time unit",
          "schema": {
            "type": "string",
            "enum": ["Seconds", "Minutes", "Hours", "Days", "Months", "Years"]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "report.getAutoCleanDates",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["DELETE REPORTS"],
      "params": [],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "bw_snapshots": {
              "title": "",
              "type": "array",
              "items": [
                {
                  "index": 0,
                  "title": "relative time",
                  "type": "integer"
                },
                {
                  "index": 1,
                  "title": "relative time unit",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "Seconds",
                      "Minutes",
                      "Hours",
                      "Days",
                      "Months",
                      "Years"
                    ]
                  }
                }
              ],
              "length": "2"
            },
            "connection_log": {
              "title": "",
              "type": "array",
              "items": [
                {
                  "index": 0,
                  "title": "relative time",
                  "type": "integer"
                },
                {
                  "index": 1,
                  "title": "relative time unit",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "Seconds",
                      "Minutes",
                      "Hours",
                      "Days",
                      "Months",
                      "Years"
                    ]
                  }
                }
              ],
              "length": "2"
            },
            "credit_change": {
              "title": "",
              "type": "array",
              "items": [
                {
                  "index": 0,
                  "title": "relative time",
                  "type": "integer"
                },
                {
                  "index": 1,
                  "title": "relative time unit",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "Seconds",
                      "Minutes",
                      "Hours",
                      "Days",
                      "Months",
                      "Years"
                    ]
                  }
                }
              ],
              "length": "2"
            },
            "snapshots": {
              "title": "",
              "type": "array",
              "items": [
                {
                  "index": 0,
                  "title": "relative time",
                  "type": "integer"
                },
                {
                  "index": 1,
                  "title": "relative time unit",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "Seconds",
                      "Minutes",
                      "Hours",
                      "Days",
                      "Months",
                      "Years"
                    ]
                  }
                }
              ],
              "length": "2"
            },
            "user_audit_log": {
              "title": "",
              "type": "array",
              "items": [
                {
                  "index": 0,
                  "title": "relative time",
                  "type": "integer"
                },
                {
                  "index": 1,
                  "title": "relative time unit",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "Seconds",
                      "Minutes",
                      "Hours",
                      "Days",
                      "Months",
                      "Years"
                    ]
                  }
                }
              ],
              "length": "2"
            },
            "web_analyzer_log": {
              "title": "",
              "type": "array",
              "items": [
                {
                  "index": 0,
                  "title": "relative time",
                  "type": "integer"
                },
                {
                  "index": 1,
                  "title": "relative time unit",
                  "schema": {
                    "type": "string",
                    "enum": [
                      "Seconds",
                      "Minutes",
                      "Hours",
                      "Days",
                      "Months",
                      "Years"
                    ]
                  }
                }
              ],
              "length": "2"
            }
          }
        }
      }
    },
    {
      "name": "report.getManagementSummaryReport",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "login_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "login_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "login_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "login_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "username": {
                "title": "",
                "type": "string",
                "required": false
              },
              "voip_username": {
                "title": "",
                "type": "string",
                "required": false
              },
              "user_ids": {
                "title": "",
                "type": "string",
                "required": false
              },
              "view_period": {
                "title": "",
                "type": "string",
                "enum": ["daily", "weekly", "monthly", "yearly"]
              },
              "included_objects": {
                "title": "",
                "type": "array",
                "required": false
              },
              "report_targets": {
                "title": "",
                "type": "array",
                "items": {
                  "title": "",
                  "schema": {
                    "type": "string",
                    "enum": ["duration", "credit", "in_bytes", "out_bytes"]
                  }
                },
                "required": false
              },
              "called_number": {
                "title": "",
                "type": "string",
                "required": false
              },
              "called_number_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "prefix_name": {
                "title": "",
                "type": "string",
                "required": false
              },
              "prefix_name_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "called_ip": {
                "title": "",
                "type": "string",
                "required": false
              },
              "dnis": {
                "title": "",
                "type": "string",
                "required": false
              },
              "immediate_children_isps_only": {
                "title": "true if exists, ",
                "type": "boolean",
                "required": false
              },
              "isp_names": {
                "title": "list of isp names, or string of one isp name",
                "type": ["array", "string"],
                "required": false
              }
            }
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "array"
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getSystemAuditLogs",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE SYSTEM AUDIT LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "categories": {
                "title": "",
                "type": "array",
                "items": {
                  "title": "",
                  "schema": {
                    "type": "string",
                    "enum": {
                      "0": "_NO_CATEGORY_",
                      "1": "RAS",
                      "2": "CHARGE",
                      "3": "ISP",
                      "4": "VOIP-TARIFF",
                      "5": "VOIP-PREFIX-GROUP",
                      "6": "ADMIN",
                      "7": "VOIP-PROVIDER",
                      "8": "VOIP-ROUTING-PROFILE",
                      "9": "VOIP-ROUTE",
                      "10": "VOIP-ROUTE-PREFIX",
                      "11": "ISP PAGE STYLE",
                      "12": "ONLINE-PAYMENT"
                    }
                  }
                },
                "required": false
              },
              "events": {
                "title": "",
                "type": "array",
                "items": {
                  "title": "",
                  "schema": {
                    "type": "string",
                    "enum": {
                      "1": "ADD",
                      "2": "CHANGE",
                      "3": "DELETE"
                    }
                  }
                },
                "required": false
              },
              "isp_names": {
                "title": "list of isp names, or string of one isp name",
                "type": ["array", "string"],
                "required": false
              },
              "admin": {
                "title": "admin username",
                "type": "string",
                "required": false
              },
              "change_time_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "change_time_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "change_time_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "object_id": {
                "title": "",
                "type": "integer",
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "change_time",
              "object_id",
              "admin_id",
              "event",
              "category",
              "isp_id"
            ]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "total number of rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "object",
                "properties": {
                  "admin_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "admin_name": {
                    "title": "",
                    "type": "string"
                  },
                  "attr_name": {
                    "title": "",
                    "type": "string"
                  },
                  "audit_log_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "category": {
                    "title": "",
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 12,
                    "enum": {
                      "0": "_NO_CATEGORY_",
                      "1": "RAS",
                      "2": "CHARGE",
                      "3": "ISP",
                      "4": "VOIP-TARIFF",
                      "5": "VOIP-PREFIX-GROUP",
                      "6": "ADMIN",
                      "7": "VOIP-PROVIDER",
                      "8": "VOIP-ROUTING-PROFILE",
                      "9": "VOIP-ROUTE",
                      "10": "VOIP-ROUTE-PREFIX",
                      "11": "ISP PAGE STYLE",
                      "12": "ONLINE-PAYMENT"
                    }
                  },
                  "category_repr": {
                    "title": "",
                    "type": "string",
                    "enum": [
                      "_NO_CATEGORY_",
                      "RAS",
                      "CHARGE",
                      "ISP",
                      "VOIP-TARIFF",
                      "VOIP-PREFIX-GROUP",
                      "ADMIN",
                      "VOIP-PROVIDER",
                      "VOIP-ROUTING-PROFILE",
                      "VOIP-ROUTE",
                      "VOIP-ROUTE-PREFIX",
                      "ISP PAGE STYLE",
                      "ONLINE-PAYMENT"
                    ]
                  },
                  "change_time": {
                    "title": "",
                    "type": "string"
                  },
                  "change_time_formatted": {
                    "title": "",
                    "type": "string"
                  },
                  "event": {
                    "title": "",
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 3,
                    "enum": {
                      "1": "ADD",
                      "2": "CHANGE",
                      "3": "DELETE"
                    }
                  },
                  "event_repr": {
                    "title": "",
                    "type": "string",
                    "enum": ["ADD", "CHANGE", "DELETE"]
                  },
                  "isp_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "isp_name": {
                    "title": "",
                    "type": "string"
                  },
                  "new_value": {
                    "title": "",
                    "type": "string"
                  },
                  "object_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "object_repr": {
                    "title": "",
                    "type": "string"
                  },
                  "old_value": {
                    "title": "",
                    "type": "string"
                  },
                  "remote_ip": {
                    "title": "",
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "name": "report.getOnlinePaymentReport",
      "description": "",
      "auth_type": ["ADMIN", "NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "requester_ids": {
                "title": "Comma-seperated string of User IDs (or Admin IDs)",
                "type": "string",
                "required": false
              },
              "requester_type": {
                "title": "",
                "type": "string",
                "enum": ["USER", "ADMIN"]
              },
              "reference_id": {
                "title": "",
                "type": "string",
                "required": false
              },
              "amount": {
                "title": "",
                "type": "number",
                "required": false
              },
              "amount_op": {
                "title": "",
                "type": "string",
                "enum": ["=", ">", "<", ">=", "<="]
              },
              "payment_date_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "payment_date_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "payment_date_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "payment_date_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "succeed": {
                "title": "",
                "type": "string",
                "enum": ["yes", "no"]
              },
              "gateway_name": {
                "title": "list of gateway names, or string of one gateway name",
                "type": ["array", "string"],
                "required": false
              }
            }
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "payment_id",
              "gateway_id",
              "unique_id",
              "amount",
              "payment_date",
              "requester_id",
              "requester_type",
              "succeed"
            ]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "total_rows": {
              "title": "total number of rows",
              "type": "integer"
            },
            "report": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "object",
                "properties": {
                  "amount": {
                    "title": "",
                    "type": "number"
                  },
                  "details": {
                    "title": "",
                    "type": "array",
                    "items": {
                      "title": "",
                      "type": "object",
                      "properties": {
                        "comment": {
                          "title": "",
                          "type": "string"
                        },
                        "log_date": {
                          "title": "",
                          "type": "string"
                        },
                        "log_id": {
                          "title": "",
                          "type": "integer"
                        },
                        "payment_id": {
                          "title": "",
                          "type": "integer"
                        },
                        "result_code": {
                          "title": "0 if successfull, otherwise Bank's error code",
                          "type": "integer"
                        },
                        "result_text": {
                          "title": "'Successful' or text of error",
                          "type": "string"
                        },
                        "stage_name": {
                          "title": "",
                          "type": "string",
                          "enum": {
                            "Prepare": "",
                            "Settle": "for Bank Mellat only",
                            "Verify": "",
                            "After-Verify": "only if there was an error after Verify stage"
                          }
                        }
                      }
                    }
                  },
                  "gateway_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "gateway_name": {
                    "title": "",
                    "type": "string"
                  },
                  "isp_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "log_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "payment_date": {
                    "title": "",
                    "type": "string"
                  },
                  "payment_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "reference_id": {
                    "title": "",
                    "type": "string"
                  },
                  "requester_id": {
                    "title": "",
                    "type": "integer"
                  },
                  "requester_type": {
                    "title": "",
                    "type": "string",
                    "enum": ["USER", "ADMIN"]
                  },
                  "succeed": {
                    "title": "",
                    "type": "string",
                    "enum": {
                      "t": "true",
                      "f": "false"
                    }
                  },
                  "unique_id": {
                    "title": "",
                    "type": "string"
                  },
                  "username": {
                    "title": "user's username",
                    "type": "string"
                  },
                  "name": {
                    "title": "user's full name",
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "name": "report.saveConnections",
      "description": "use SystemNotification.getNotifications() method to see if the report is finished         and get the URL to download it",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        },
        {
          "name": "from",
          "description": "start index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "end index, for pagination",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "user_id",
              "credit_used",
              "login_time",
              "logout_time",
              "successful",
              "service",
              "ras_id",
              "connection_log_id"
            ]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "report.saveConnectionUsages",
      "description": "use SystemNotification.getNotifications() method to see if the report is finished         and get the URL to download it",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "report_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["inout_usages", "credit_usages", "time_usages"]
          }
        },
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        },
        {
          "name": "cols",
          "description": "",
          "schema": {
            "type": "array",
            "items": {
              "title": "",
              "schema": {
                "type": "string",
                "enum": [
                  "user_id",
                  "user_name",
                  "serial",
                  "group_name",
                  "isp_name",
                  "creation_date",
                  "name"
                ]
              }
            }
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["creation_date", "normal_username", "sum"]
          }
        },
        {
          "name": "output_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["csv", "pdf"]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "report.savePrefixNameUsage",
      "description": "use SystemNotification.getNotifications() method to see if the report is finished and get the URL to download it",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getConnections' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "prefix_name",
              "prefix_code",
              "duration_sum",
              "count",
              "credit"
            ]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        },
        {
          "name": "output_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["csv", "pdf"]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "report.saveOnlinePaymentReport",
      "description": "use SystemNotification.getNotifications() method to see if the report is finished and get the URL to download it",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE CONNECTION LOGS"],
      "params": [
        {
          "name": "conds",
          "description": "the same as 'report.getOnlinePaymentReport' method",
          "schema": {
            "type": "object",
            "properties": {}
          }
        },
        {
          "name": "sort_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "payment_id",
              "gateway_id",
              "unique_id",
              "amount",
              "payment_date",
              "requester_id",
              "requester_type",
              "succeed"
            ]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        },
        {
          "name": "output_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["csv", "pdf"]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "report.getDayNightUsage",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["GOD"],
      "params": [
        {
          "name": "start_date",
          "description": "gregorian date, format '%Y-%m-%d'",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "end_date",
          "description": "gregorian date, format '%Y-%m-%d'",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "nightly_charge_rule_ids",
          "description": "list of Charge Rule IDs that are Nightly (Free)",
          "schema": {
            "type": "array"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "night_download": {
              "title": "in bytes",
              "type": "integer"
            },
            "night_upload": {
              "title": "in bytes",
              "type": "integer"
            },
            "day_download": {
              "title": "in bytes",
              "type": "integer"
            },
            "day_upload": {
              "title": "in bytes",
              "type": "integer"
            }
          }
        }
      }
    }
  ]
}