Document basic SUP command usage (2600hz#6044)

Created AST walker to also process exported functions
from *_maintenance modules (and a select few others) and generate a
ref doc with a table of SUP-able functions.

applications/acdc/doc/acdc_agent_maintenance.md

@@ -0,0 +1,9 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `acct_restart/1` | `(AcctId)` | |
+| `acct_status/1` | `(AcctId)` | |
+| `agent_restart/2` | `(AcctId,AgentId)` | |
+| `agent_status/2` | `(AcctId,AgentId)` | |
+| `status/0` |  | |

applications/acdc/doc/maintenance.md

@@ -0,0 +1,39 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `agent_detail/2` | `(AcctId,AgentId)` | |
+| `agent_login/2` | `(AcctId,AgentId)` | |
+| `agent_logout/2` | `(AcctId,AgentId)` | |
+| `agent_pause/2` | `(AcctId,AgentId)` | |
+| `agent_pause/3` | `(AcctId,AgentId,Timeout)` | |
+| `agent_presence_id/2` | `(AccountId,AgentId)` | |
+| `agent_queue_login/3` | `(AcctId,AgentId,QueueId)` | |
+| `agent_queue_logout/3` | `(AcctId,AgentId,QueueId)` | |
+| `agent_resume/2` | `(AcctId,AgentId)` | |
+| `agent_summary/2` | `(AcctId,AgentId)` | |
+| `agents_detail/0` |  | |
+| `agents_detail/1` | `(AcctId)` | |
+| `agents_summary/0` |  | |
+| `agents_summary/1` | `(AcctId)` | |
+| `current_agents/1` | `(AccountId)` | |
+| `current_calls/1` | `(AccountId)` | |
+| `current_calls/2` | `(AccountId,Props) | (AccountId,QueueId)` | |
+| `current_queues/1` | `(AccountId)` | |
+| `current_statuses/1` | `(AccountId)` | |
+| `flush_call_stat/1` | `(CallId)` | |
+| `logout_agent/2` | `(AccountId,AgentId)` | |
+| `logout_agents/1` | `(AccountId)` | |
+| `migrate/0` |  | |
+| `migrate_to_acdc_db/0` |  | |
+| `queue_detail/2` | `(AcctId,QueueId)` | |
+| `queue_restart/2` | `(AcctId,QueueId)` | |
+| `queue_summary/2` | `(AcctId,QueueId)` | |
+| `queues_detail/0` |  | |
+| `queues_detail/1` | `(AcctId)` | |
+| `queues_restart/1` | `(AcctId)` | |
+| `queues_summary/0` |  | |
+| `queues_summary/1` | `(AcctId)` | |
+| `refresh/0` |  | |
+| `refresh_account/1` | `(Account)` | |
+| `register_views/0` |  | |

applications/acdc/doc/ref/acdc_agent_maintenance.md

@@ -0,0 +1,9 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `acct_restart/1` | `(AcctId)` | |
+| `acct_status/1` | `(AcctId)` | |
+| `agent_restart/2` | `(AcctId,AgentId)` | |
+| `agent_status/2` | `(AcctId,AgentId)` | |
+| `status/0` |  | |

applications/acdc/doc/ref/maintenance.md

@@ -0,0 +1,39 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `agent_detail/2` | `(AcctId,AgentId)` | |
+| `agent_login/2` | `(AcctId,AgentId)` | |
+| `agent_logout/2` | `(AcctId,AgentId)` | |
+| `agent_pause/2` | `(AcctId,AgentId)` | |
+| `agent_pause/3` | `(AcctId,AgentId,Timeout)` | |
+| `agent_presence_id/2` | `(AccountId,AgentId)` | |
+| `agent_queue_login/3` | `(AcctId,AgentId,QueueId)` | |
+| `agent_queue_logout/3` | `(AcctId,AgentId,QueueId)` | |
+| `agent_resume/2` | `(AcctId,AgentId)` | |
+| `agent_summary/2` | `(AcctId,AgentId)` | |
+| `agents_detail/0` |  | |
+| `agents_detail/1` | `(AcctId)` | |
+| `agents_summary/0` |  | |
+| `agents_summary/1` | `(AcctId)` | |
+| `current_agents/1` | `(AccountId)` | |
+| `current_calls/1` | `(AccountId)` | |
+| `current_calls/2` | `(AccountId,Props) | (AccountId,QueueId)` | |
+| `current_queues/1` | `(AccountId)` | |
+| `current_statuses/1` | `(AccountId)` | |
+| `flush_call_stat/1` | `(CallId)` | |
+| `logout_agent/2` | `(AccountId,AgentId)` | |
+| `logout_agents/1` | `(AccountId)` | |
+| `migrate/0` |  | |
+| `migrate_to_acdc_db/0` |  | |
+| `queue_detail/2` | `(AcctId,QueueId)` | |
+| `queue_restart/2` | `(AcctId,QueueId)` | |
+| `queue_summary/2` | `(AcctId,QueueId)` | |
+| `queues_detail/0` |  | |
+| `queues_detail/1` | `(AcctId)` | |
+| `queues_restart/1` | `(AcctId)` | |
+| `queues_summary/0` |  | |
+| `queues_summary/1` | `(AcctId)` | |
+| `refresh/0` |  | |
+| `refresh_account/1` | `(Account)` | |
+| `register_views/0` |  | |

applications/blackhole/doc/maintenance.md

@@ -0,0 +1,9 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `running_modules/0` |  | |
+| `start_module/1` | `(ModuleBin)` | |
+| `start_module/2` | `(ModuleBin,Persist)` | |
+| `stop_module/1` | `(ModuleBin)` | |
+| `stop_module/2` | `(ModuleBin,Persist)` | |

applications/blackhole/doc/ref/maintenance.md

@@ -0,0 +1,9 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `running_modules/0` |  | |
+| `start_module/1` | `(ModuleBin)` | |
+| `start_module/2` | `(ModuleBin,Persist)` | |
+| `stop_module/1` | `(ModuleBin)` | |
+| `stop_module/2` | `(ModuleBin,Persist)` | |

applications/braintree/doc/maintenance.md

@@ -0,0 +1,7 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `sync_account_services_payments_info/1` | `(AccountId)` | |
+| `sync_all_accounts_payments_info/0` |  | |
+| `sync_payment_info/2` | `(AccountId,CardId)` | |

applications/braintree/doc/ref/maintenance.md

@@ -0,0 +1,7 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `sync_account_services_payments_info/1` | `(AccountId)` | |
+| `sync_all_accounts_payments_info/0` |  | |
+| `sync_payment_info/2` | `(AccountId,CardId)` | |

applications/call_inspector/doc/maintenance.md

@@ -0,0 +1,13 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `callid_details/1` | `(CallId)` | |
+| `flush/0` |  | |
+| `flush/1` | `(CallId)` | |
+| `inspect_call_id/1` | `(CallId)` | |
+| `list_active_parsers/0` |  | |
+| `start_freeswitch_parser/3` | `(Filename,LogIP,LogPort)` | |
+| `start_hep_parser/2` | `(IP,Port)` | |
+| `start_kamailio_parser/3` | `(Filename,LogIP,LogPort)` | |
+| `stop_active_parser/1` | `(Id)` | |

applications/call_inspector/doc/ref/maintenance.md

@@ -0,0 +1,13 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `callid_details/1` | `(CallId)` | |
+| `flush/0` |  | |
+| `flush/1` | `(CallId)` | |
+| `inspect_call_id/1` | `(CallId)` | |
+| `list_active_parsers/0` |  | |
+| `start_freeswitch_parser/3` | `(Filename,LogIP,LogPort)` | |
+| `start_hep_parser/2` | `(IP,Port)` | |
+| `start_kamailio_parser/3` | `(Filename,LogIP,LogPort)` | |
+| `stop_active_parser/1` | `(Id)` | |

applications/callflow/doc/ref/maintenance.md

@@ -0,0 +1,30 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `account_set_classifier_deny/2` | `(Classifier,Account)` | |
+| `account_set_classifier_inherit/2` | `(Classifier,Account)` | |
+| `all_accounts_set_classifier_deny/1` | `(Classifier)` | |
+| `all_accounts_set_classifier_inherit/1` | `(Classifier)` | |
+| `allow_authz_context/1` | `(App)` | |
+| `allow_authz_context/2` | `(App,DefaultContext)` | |
+| `blocking_refresh/0` |  | |
+| `call_count/0` |  | |
+| `deny_authz_context/1` | `(App)` | |
+| `device_classifier_deny/2` | `(Classifier,Uri)` | |
+| `device_classifier_inherit/2` | `(Classifier,Uri)` | |
+| `disable_authz_contexts/0` |  | |
+| `enable_authz_contexts/0` |  | |
+| `flush/0` |  | |
+| `list_account_restrictions/1` | `(Account)` | |
+| `lookup_endpoint/1` | `(URI)` | |
+| `lookup_endpoint/2` | `(Username,Realm)` | |
+| `migrate_menus/0` |  | |
+| `migrate_menus/1` | `(Account)` | |
+| `migrate_recorded_name/1` | `(Db)` | |
+| `migrate_recorded_names/0` |  | |
+| `refresh/0` |  | |
+| `refresh/1` | `(Account)` | |
+| `show_calls/0` |  | |
+| `update_feature_codes/0` |  | |
+| `update_feature_codes/1` | `(Account)` | |

applications/conference/doc/maintenance.md

@@ -0,0 +1,7 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `blocking_refresh/0` |  | |
+| `refresh/0` |  | |
+| `refresh/1` | `(_Account)` | |

applications/conference/doc/ref/maintenance.md

@@ -0,0 +1,7 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `blocking_refresh/0` |  | |
+| `refresh/0` |  | |
+| `refresh/1` | `(_Account)` | |

applications/crossbar/doc/cb_apps_maintenance.md

@@ -0,0 +1,5 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `migrate/1` | `(Account)` | |

applications/crossbar/doc/ref/cb_apps_maintenance.md

@@ -0,0 +1,5 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `migrate/1` | `(Account)` | |

applications/crossbar/doc/ref/maintenance.md

@@ -0,0 +1,51 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `allow_account_number_additions/1` | `(AccountId)` | |
+| `app/1` | `(AppNameOrId)` | |
+| `apps/0` |  | |
+| `create_account/1` | `(Context)` | |
+| `create_account/4` | `(AccountName,Realm,Username,Password)` | |
+| `db_init/0` |  | |
+| `demote_account/1` | `(AccountId)` | |
+| `descendants_count/0` |  | |
+| `descendants_count/1` | `(AccountId)` | |
+| `disable_account/1` | `(AccountId)` | |
+| `disallow_account_number_additions/1` | `(AccountId)` | |
+| `does_schema_exist/1` | `(Schema)` | |
+| `enable_account/1` | `(AccountId)` | |
+| `find_account_by_id/1` | `(Id)` | |
+| `find_account_by_name/1` | `(Name)` | |
+| `find_account_by_number/1` | `(Number)` | |
+| `find_account_by_realm/1` | `(Realm)` | |
+| `flush/0` |  | |
+| `init_app/1` | `(AppPath)` | |
+| `init_app/2` | `(AppPath,AppUrl)` | |
+| `init_apps/1` | `(AppsPath)` | |
+| `init_apps/2` | `(AppsPath,AppUrl)` | |
+| `migrate/0` |  | |
+| `migrate/1` | `(Accounts)` | |
+| `migrate_account_data/1` | `(Account)` | |
+| `migrate_accounts_data/0` |  | |
+| `migrate_ring_group_callflow/1` | `(Account)` | |
+| `move_account/2` | `(Account,ToAccount)` | |
+| `promote_account/1` | `(AccountId)` | |
+| `refresh/0` |  | |
+| `refresh/1` | `(Value)` | |
+| `refresh_app/1` | `(AppPath)` | |
+| `refresh_app/2` | `(AppPath,AppUrl)` | |
+| `refresh_apps/1` | `(AppsPath)` | |
+| `refresh_apps/2` | `(AppsPath,AppUrl)` | |
+| `register_views/0` |  | |
+| `running_modules/0` |  | |
+| `set_app_description/2` | `(AppId,Value)` | |
+| `set_app_extended_description/2` | `(AppId,Value)` | |
+| `set_app_features/2` | `(AppId,Value)` | |
+| `set_app_field/3` | `(AppId,Field,Value)` | |
+| `set_app_icon/2` | `(AppId,PathToPNGIcon)` | |
+| `set_app_label/2` | `(AppId,Value)` | |
+| `set_app_screenshots/2` | `(AppId,PathToScreenshotsFolder)` | |
+| `start_module/1` | `(Module)` | |
+| `stop_module/1` | `(Module)` | |
+| `update_schemas/0` |  | |

applications/doodle/doc/maintenance.md

@@ -0,0 +1,16 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `check_pending_sms_for_delivery/1` | `(AccountId)` | |
+| `check_pending_sms_for_outbound_delivery/1` | `(AccountId)` | |
+| `check_sms_by_device_id/2` | `(AccountId,DeviceId) | (_AccountId,undefined)` | |
+| `check_sms_by_owner_id/2` | `(AccountId,OwnerId) | (_AccountId,undefined)` | |
+| `flush/0` |  | |
+| `send_outbound_sms/2` | `(To,Msg)` | |
+| `send_outbound_sms/3` | `(To,Msg,Times)` | |
+| `send_outbound_sms/4` | `(To,From,RouteId,Msg)` | |
+| `send_outbound_sms/5` | `(To,From,RouteId,Msg,Times)` | |
+| `start_check_sms_by_account/2` | `(AccountId,JObj)` | |
+| `start_check_sms_by_device_id/2` | `(AccountId,DeviceId)` | |
+| `start_check_sms_by_owner_id/2` | `(AccountId,OwnerId)` | |

applications/doodle/doc/ref/maintenance.md

@@ -0,0 +1,16 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `check_pending_sms_for_delivery/1` | `(AccountId)` | |
+| `check_pending_sms_for_outbound_delivery/1` | `(AccountId)` | |
+| `check_sms_by_device_id/2` | `(AccountId,DeviceId) | (_AccountId,undefined)` | |
+| `check_sms_by_owner_id/2` | `(AccountId,OwnerId) | (_AccountId,undefined)` | |
+| `flush/0` |  | |
+| `send_outbound_sms/2` | `(To,Msg)` | |
+| `send_outbound_sms/3` | `(To,Msg,Times)` | |
+| `send_outbound_sms/4` | `(To,From,RouteId,Msg)` | |
+| `send_outbound_sms/5` | `(To,From,RouteId,Msg,Times)` | |
+| `start_check_sms_by_account/2` | `(AccountId,JObj)` | |
+| `start_check_sms_by_device_id/2` | `(AccountId,DeviceId)` | |
+| `start_check_sms_by_owner_id/2` | `(AccountId,OwnerId)` | |

applications/ecallmgr/doc/ref/maintenance.md

@@ -0,0 +1,75 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `acl_summary/0` |  | |
+| `acl_summary/1` | `(false) | (true) | (AsDefault)` | |
+| `add_fs_node/1` | `(FSNode)` | |
+| `add_fs_node/2` | `(FSNode,false) | (FSNode,true) | (FSNode,AsDefault)` | |
+| `allow_carrier/1` | `(Name)` | |
+| `allow_carrier/2` | `(Name,IP)` | |
+| `allow_carrier/3` | `(Name,IP,false) | (Name,IP,true) | (Name,IP,AsDefault)` | |
+| `allow_sbc/1` | `(Name)` | |
+| `allow_sbc/2` | `(Name,IP)` | |
+| `allow_sbc/3` | `(Name,IP,false) | (Name,IP,true) | (Name,IP,AsDefault)` | |
+| `carrier_acls/0` |  | |
+| `carrier_acls/1` | `(false) | (true) | (AsDefault)` | |
+| `channel_details/0` |  | |
+| `channel_details/1` | `(UUID)` | |
+| `channel_summary/0` |  | |
+| `channel_summary/1` | `(Node)` | |
+| `check_sync/2` | `(Username,Realm)` | |
+| `conference_details/0` |  | |
+| `conference_details/1` | `(UUID)` | |
+| `conference_summary/0` |  | |
+| `conference_summary/1` | `(Node)` | |
+| `deny_carrier/1` | `(Name)` | |
+| `deny_carrier/2` | `(Name,IP)` | |
+| `deny_carrier/3` | `(Name,IP,false) | (Name,IP,true) | (Name,IP,AsDefault)` | |
+| `deny_sbc/1` | `(Name)` | |
+| `deny_sbc/2` | `(Name,IP)` | |
+| `deny_sbc/3` | `(Name,IP,false) | (Name,IP,true) | (Name,IP,AsDefault)` | |
+| `disable_authz/0` |  | |
+| `disable_local_resource_authz/0` |  | |
+| `enable_authz/0` |  | |
+| `enable_local_resource_authz/0` |  | |
+| `flush_acls/0` |  | |
+| `flush_authn/0` |  | |
+| `flush_node_channels/1` | `(Node)` | |
+| `flush_node_conferences/1` | `(Node)` | |
+| `flush_registrar/0` |  | |
+| `flush_registrar/1` | `(Realm)` | |
+| `flush_registrar/2` | `(Username,Realm)` | |
+| `flush_util/0` |  | |
+| `get_fs_nodes/0` |  | |
+| `hangup_long_running_channels/0` |  | |
+| `hangup_long_running_channels/1` | `(MaxAge)` | |
+| `limit_channel_uptime/1` | `(MaxAge)` | |
+| `limit_channel_uptime/2` | `(MaxAge,AsDefault)` | |
+| `list_fs_nodes/0` |  | |
+| `node_details/0` |  | |
+| `node_details/1` | `(NodeName)` | |
+| `node_summary/0` |  | |
+| `registrar_details/0` |  | |
+| `registrar_details/1` | `(Realm)` | |
+| `registrar_details/2` | `(Username,Realm)` | |
+| `registrar_summary/0` |  | |
+| `registrar_summary/1` | `(Realm)` | |
+| `registrar_sync/0` |  | |
+| `reload_acls/0` |  | |
+| `remove_acl/1` | `(Name)` | |
+| `remove_acl/2` | `(Name,false) | (Name,true) | (Name,AsDefault)` | |
+| `remove_fs_node/1` | `(FSNode)` | |
+| `remove_fs_node/2` | `(FSNode,false) | (FSNode,true) | (FSNode,AsDefault)` | |
+| `sbc_acls/0` |  | |
+| `sbc_acls/1` | `(false) | (true) | (AsDefault)` | |
+| `show_calls/0` |  | |
+| `show_channels/0` |  | |
+| `sync_channels/0` |  | |
+| `sync_channels/1` | `(Node)` | |
+| `sync_conferences/0` |  | |
+| `sync_conferences/1` | `(Node)` | |
+| `test_carrier_ip/1` | `(IP)` | |
+| `test_carrier_ip/2` | `(IP,Node) | (IP,_) | (_,[])` | |
+| `test_sbc_ip/1` | `(IP)` | |
+| `test_sbc_ip/2` | `(IP,Node) | (IP,_) | (_,[])` | |

applications/edr/doc/maintenance.md

@@ -0,0 +1,14 @@
+## SUP-able functions
+
+| Function | Arguments | Description |
+| -------- | --------- | ----------- |
+| `delete_backend/1` | `(Name)` | |
+| `disable_backend/1` | `(Name)` | |
+| `enable_backend/1` | `(Name)` | |
+| `register_backend/1` | `(Name)` | |
+| `register_backend/2` | `(Name,Type)` | |
+| `register_backend/3` | `(Name,Type,Opts)` | |
+| `register_backend/4` | `(Name,Type,Opts,Bindings)` | |
+| `register_backend/5` | `(Name,Type,Opts,Bindings,Enabled)` | |
+| `registered_backends/0` |  | |
+| `restart_backend/1` | `(Name)` | |