Locate Free Extension & Powered by OS (#150)

Co-authored-by: Olivia Curtis <[email protected]> Co-authored-by: Malkin0xb <[email protected]> Co-authored-by: CHOPP3D <[email protected]> Co-authored-by: Malkin0xb <[email protected]>
Jordan-Prescott · Nov 22, 2024 · 30703fa · 30703fa
1 parent f93caec
commit 30703fa
Show file tree

Hide file tree

Showing 59 changed files with 1,493 additions and 132 deletions.
diff --git a/docs/.gitbook/assets/Frame 2.png b/docs/.gitbook/assets/Frame 2.png
diff --git a/docs/.gitbook/assets/Frame 5.png b/docs/.gitbook/assets/Frame 5.png
diff --git a/docs/.gitbook/assets/call_flow.jpg b/docs/.gitbook/assets/call_flow.jpg
diff --git a/docs/.gitbook/assets/image (10).png b/docs/.gitbook/assets/image (10).png
diff --git a/docs/.gitbook/assets/image (11).png b/docs/.gitbook/assets/image (11).png
diff --git a/docs/.gitbook/assets/image (12).png b/docs/.gitbook/assets/image (12).png
diff --git a/docs/.gitbook/assets/image (14).png b/docs/.gitbook/assets/image (14).png
diff --git a/docs/.gitbook/assets/image (15).png b/docs/.gitbook/assets/image (15).png
diff --git a/docs/.gitbook/assets/image (16).png b/docs/.gitbook/assets/image (16).png
diff --git a/docs/.gitbook/assets/image (17).png b/docs/.gitbook/assets/image (17).png
diff --git a/docs/.gitbook/assets/image (18).png b/docs/.gitbook/assets/image (18).png
diff --git a/docs/.gitbook/assets/image (19).png b/docs/.gitbook/assets/image (19).png
diff --git a/docs/.gitbook/assets/image (20).png b/docs/.gitbook/assets/image (20).png
diff --git a/docs/.gitbook/assets/image (21).png b/docs/.gitbook/assets/image (21).png
diff --git a/docs/.gitbook/assets/image (22).png b/docs/.gitbook/assets/image (22).png
diff --git a/docs/.gitbook/assets/image (23).png b/docs/.gitbook/assets/image (23).png
diff --git a/docs/.gitbook/assets/image (24).png b/docs/.gitbook/assets/image (24).png
diff --git a/docs/.gitbook/assets/image (25).png b/docs/.gitbook/assets/image (25).png
diff --git a/docs/.gitbook/assets/image (26).png b/docs/.gitbook/assets/image (26).png
diff --git a/docs/.gitbook/assets/image (27).png b/docs/.gitbook/assets/image (27).png
diff --git a/docs/.gitbook/assets/image (28).png b/docs/.gitbook/assets/image (28).png
diff --git a/docs/.gitbook/assets/image (29).png b/docs/.gitbook/assets/image (29).png
diff --git a/docs/.gitbook/assets/image (30).png b/docs/.gitbook/assets/image (30).png
diff --git a/docs/.gitbook/assets/powered-by-os.svg b/docs/.gitbook/assets/powered-by-os.svg
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -35,6 +35,8 @@
     * [🟢 Registration](docs/methods/registration/README.md)
       * [💚 GET - User Registration](docs/methods/registration/user-registration.md)
       * [💚 GET - Bulk User Registration](docs/methods/registration/bulk-user-registration.md)
+    * [🤵 Administrators](docs/methods/administrators/README.md)
+      * [🤵 POST - Group Admin](docs/methods/administrators/post.group-admin.md)
     * [🔢 Alternate Numbers](docs/methods/alternate-numbers/README.md)
       * [1️⃣ GET - User Alternate Numbers](docs/methods/alternate-numbers/get-user-alternate-numbers.md)
     * [📆 Schedules](docs/methods/schedules.md)
@@ -52,18 +54,23 @@
       * [🚿 POST - Group Trunk Group](docs/methods/trunk-groups/post-group-trunk-group.md)
     * [🤵 User](docs/methods/user/README.md)
       * [🆔 GET - User By ID](docs/methods/user/get-user-by-id.md)
+      * [🧅 GET - User Login Info](docs/methods/user/get-user-login-info.md)
+      * [🔐 GET - User Portal Passcode](docs/methods/user/get-user-portal-passcode.md)
       * [👯 GET - Users](docs/methods/user/get-users.md)
       * [📮 POST - User](docs/methods/user/post-user.md)
+      * [⭕ POST - User Reset](docs/methods/user/post-user-reset.md)
       * [👩‍💻 PUT - User](docs/methods/user/put-user.md)
+      * [🆔 PUT - User ID](docs/methods/user/put-user-id.md)
       * [👩‍👩‍👧‍👧 PUT - Users Bulk](docs/methods/user/put-users-bulk.md)
       * [🔏 PUT - User Portal Passcode](docs/methods/user/put-user-portal-passcode.md)
+      * [🤝 PUT - User Group ID Update](docs/methods/user/put-user-group-id-update.md)
+      * [❌ DEL - User](docs/methods/user/del-user.md)
     * [🤝 Groups](docs/methods/groups/README.md)
       * [🤝 GET - Service Provider Groups](docs/methods/groups/get-groups.md)
       * [🤝 GET - Group Information](docs/methods/groups/get-group.md)
     * [🚗 User Call Forwarding](docs/methods/call-forwarding/README.md)
       * [🚗 GET - Bulk User Call Forwarding Always](docs/methods/call-forwarding/get-user-call-forwarding-always.md)
       * [🚗 GET - User Call Forwarding Always](docs/methods/call-forwarding/get-bulk-call-forwarding-always.md)
-
       * [🚗 GET - Bulk User Call Forwarding Busy](docs/methods/call-forwarding/get-user-call-forwarding-busy.md)
       * [🚗 GET - User Call Forwarding Busy](docs/methods/call-forwarding/get-bulk-call-forwarding-busy.md)
       * [🚗 GET - Bulk User Call Forwarding Not Reachable](docs/methods/call-forwarding/get-user-call-forwarding-not-reachable.md)
@@ -91,6 +98,14 @@
       * [📖 PUT - Auto Attendant Submenu](docs/methods/auto-attendants/auto-attendant-submenu.md)
       * [📞 GET - Auto Attendants](docs/methods/auto-attendants/get-auto-attendants.md)
       * [🤙🏼 GET - Auto Attendant](docs/methods/auto-attendants/get-auto-attendant.md)
+      * [🖲️ GET - Auto Attendant Submenu Usage](docs/methods/auto-attendants/get-auto-attendant-submenu-usage.md)
+      * [🎚️ GET - Auto Attendant Submenus](docs/methods/auto-attendants/get-auto-attendant-submenus.md)
+      * [💁‍♀️ GET - Auto Attendant User](docs/methods/auto-attendants/get-auto-attendant-user.md)
+      * [✍️ POST - Auto Attendant](docs/methods/auto-attendants/post-auto-attendant.md)
+      * [👋 POST - Auto Attendant Remove User](docs/methods/auto-attendants/post-auto-attendant-remove-user.md)
+      * [🦾 POST - Auto Attendant Submenu](docs/methods/auto-attendants/post-auto-attendant-submenu.md)
+      * [🚮 DELETE - Auto Attendant](docs/methods/auto-attendants/delete-auto-attendant.md)
+      * [🛑 DELETE - Auto Attendant Submenu](docs/methods/auto-attendants/delete-auto-attendant-submenu.md)
     * [📞 Call Centers](docs/methods/call-centers/README.md)
       * [🎧 GET - Group Call Centers](docs/methods/call-centers/get-group-call-centers.md)
       * [🎧 GET - Group Call Center](docs/methods//call-centers/get-group-call-center.md)
@@ -150,6 +165,9 @@
       * [🧍 GET - Group Services](docs/methods/services/get-group-services.md)
       * [⚙️ GET - User Service Settings](docs/methods/services/get-user-service-settings.md)
       * [⚙️ PUT - User Service Settings](docs/methods/services/put-user-service-settings.md)
+    * [🚑 Emergency Zones](docs/methods/emergency-zones/README.md)
+      * [🗃️ POST - Group Emergency Zones](docs/methods/emergency-zones/post-group-emergency-zones.md)
+      * [⚠️ PUT - Group Emergency Zones](docs/methods/emergency-zones/put-group-emergency-zones.md)
     * [🛑 Do Not Disturb](docs/methods/do-not-disturb/README.md)
       * [🛑 GET - User Do Not Disturb](docs/methods/do-not-disturb/get-user-do-not-disturb.md)
       * [🛑 PUT - User Do Not Disturb](docs/methods/do-not-disturb/put-user-do-not-disturb.md)
@@ -167,6 +185,7 @@
       * [🔑 Bulk Password Reset](docs/features/scripter/bulk-password-reset.md)
       * [📜 Service Provider Trunking Capacity](docs/features/scripter/service-provider-trunking-capacity.md)
       * [💻 Webex Builder](docs/features/scripter/webex-builder.md)
+      * [Locate Free Extension](docs/features/scripter/locate-free-extension.md)
     * [📈 Reporter](docs/features/reporter/README.md)
       * [🤙 Call Flow](docs/features/reporter/call-flow/README.md)
         * [🔑 Node Key](docs/features/reporter/call-flow/node-key.md)
@@ -177,11 +196,13 @@
       * [📂 Sending Logs To A File](docs/features/logger/sending-logs-to-a-file.md)
       * [☁️ Sending Logs To A Syslog Server](docs/features/logger/sending-logs-to-a-syslog-server.md)
     * [🛑 Rate Limiting API Calls](docs/features/rate-limiting-api-calls.md)
+* [Powered By Odin's Spear](powered-by-odins-spear/README.md)
+  * [Bulk Build Group Admins](powered-by-odins-spear/bulk-build-group-admins.md)
 * [👨‍💻 Development](development.md)
 * [🆘 Troubleshooting & FAQ](troubleshooting-and-faq/README.md)
   * [🐛 Common Issues](troubleshooting-and-faq/common-issues.md)
   * [⁉️ Frequently Asked Questions](troubleshooting-and-faq/frequently-asked-questions/README.md)
-    * [1️⃣ Do You Need To Set Up Multiple Loggers For Multiple API Objects? No.](troubleshooting-and-faq/frequently-asked-questions do-you-need-to-set-up-multiple-loggers-for-multiple-api-objects-no..md)
+    * [1️⃣ Multiple Loggers](troubleshooting-and-faq/frequently-asked-questions/do-you-need-to-set-up-multiple-loggers-for-multiple-api-objects-no..md)
     * [📈 Graphviz Troubleshooting](troubleshooting-and-faq/graphviz-troubleshooting.md)
 * [🐛 Bugs and Issues](bugs-and-issues.md)
 * [🤙 Contact](contact.md)
diff --git a/docs/docs/features/reporter/call-flow/README.md b/docs/docs/features/reporter/call-flow/README.md
@@ -8,7 +8,7 @@ There is now no need to spend hours interrogating how calls to 0 flows through y
 You will need to download Graphviz in order to use this feature. Follow the instruction here [graphviz.md](graphviz.md "mention")
 {% endhint %}
 
-<figure><img src="../../../../.gitbook/assets/image (29).png" alt=""><figcaption><p>Simple call flow example of calls to the main number attached to an Auto Attendant</p></figcaption></figure>
+<figure><img src="../../../../.gitbook/assets/call_flow.jpg" alt=""><figcaption><p>Simple call flow example of calls to the main number attached to an Auto Attendant</p></figcaption></figure>
 
 ### Making Sense of The Graph
 

diff --git a/docs/docs/features/reporter/call-flow/abbreviation-key.md b/docs/docs/features/reporter/call-flow/abbreviation-key.md
@@ -6,7 +6,7 @@ description: >-
 
 # 🔑 Abbreviation Key
 
-<figure><img src="../../../../.gitbook/assets/image (25).png" alt=""><figcaption><p>Example of Call Flow showing abbreviations.</p></figcaption></figure>
+<figure><img src="../../../../.gitbook/assets/call_flow.jpg" alt=""><figcaption><p>Example of Call Flow showing abbreviations.</p></figcaption></figure>
 
 | Abbreviation | Meaning                           |
 | ------------ | --------------------------------- |

diff --git a/docs/docs/features/reporter/call-flow/node-key.md b/docs/docs/features/reporter/call-flow/node-key.md
@@ -2,9 +2,9 @@
 
 ## Call Flow Nodes
 
-<figure><img src="../../../../.gitbook/assets/image (26).png" alt=""><figcaption><p>Simple call flow example of calls to the main number attached to an Auto Attendant</p></figcaption></figure>
+<figure><img src="../../../../.gitbook/assets/call_flow.jpg" alt=""><figcaption><p>Simple call flow example of calls to the main number attached to an Auto Attendant</p></figcaption></figure>
 
-<table><thead><tr><th width="170">Node</th><th width="176">Shape/ Colour</th><th>Details</th></tr></thead><tbody><tr><td>Start/ Entry Node</td><td>Black Box Pointed Edges</td><td>This highlights the start of the flow. This is simply to guide the user to the first Broadworks Entity in the call flow. </td></tr><tr><td>Auto Attendant (AA)</td><td>Red Round Circle</td><td>This node shows the extension number in the middle of the node and also shows the key number it forwards calls to on each edge. In the above example key 2 forwards to 104.</td></tr><tr><td>Call Center (CC)</td><td>Pink Box Rounded Edges</td><td>This node represents a Call Center that will contain agents. Each edge will show the type of routing to the connecting node. For example in the above the Call Center 'OF' - OverFlows to 2001.</td></tr><tr><td>Hunt Group (HG)</td><td>Purple Box Rounded Edges</td><td>This is a Hunt Group which will contain users. Like the CC node it will also highlight the type of call forwarding to whatever the next connecting node is. In the above the  Hunt Group 2001 'CFNR' Call Forward Not Reachable to 102.</td></tr><tr><td>User (U)</td><td>Orange Box Rounded Edges</td><td>This node is a User and like the CC and HG it will show the type of call forwarding to the connecting node. In the above user 104 'CFB' Call Forwards Busy to HG 2001.</td></tr><tr><td>Exit Node</td><td>White Circle with Black Border</td><td>These nodes indicate calls leave the Broadworks system. In the above AA 3001 forwards calls to '0123456789' on key 3 exiting the system.</td></tr></tbody></table>
+<table><thead><tr><th width="170">Node</th><th width="176">Shape/ Colour</th><th>Details</th></tr></thead><tbody><tr><td>Start/ Entry Node</td><td>Black Box Pointed Edges</td><td>This highlights the start of the flow. This is simply to guide the user to the first Broadworks Entity in the call flow. </td></tr><tr><td>Auto Attendant (AA)</td><td>Dark Green Record</td><td>This node shows the extension number in the middle of the node and also shows the key number it forwards calls to on each edge. In the above example key 2 forwards to 104.</td></tr><tr><td>Call Center (CC)</td><td>Purple Record</td><td>This node represents a Call Center that will contain agents. Each edge will show the type of routing to the connecting node. For example in the above the Call Center 'OF' - OverFlows to 2001.</td></tr><tr><td>Hunt Group (HG)</td><td>Pink Record</td><td>This is a Hunt Group which will contain users. Like the CC node it will also highlight the type of call forwarding to whatever the next connecting node is. In the above the  Hunt Group 2001 'CFNR' Call Forward Not Reachable to 102.</td></tr><tr><td>User (U)</td><td>Yellow Record</td><td>This node is a User and like the CC and HG it will show the type of call forwarding to the connecting node. In the above user 104 'CFB' Call Forwards Busy to HG 2001.</td></tr><tr><td>Exit Node</td><td>White Circle with Black Border</td><td>These nodes indicate calls leave the Broadworks system. In the above AA 3001 forwards calls to '0123456789' on key 3 exiting the system.</td></tr></tbody></table>
 
 {% hint style="info" %}
 What the CFB does 'CFB' stand for! You can find all the abbreviations documented in the Abbreviation Key page. Link below.

diff --git a/docs/docs/features/scripter/aa-cc-hg-audit.md b/docs/docs/features/scripter/aa-cc-hg-audit.md
@@ -22,7 +22,7 @@ api.get.user_services_assigned()
 
 ### Return
 
-* JSON: A JSON formatted report of service packs assigned in the group.
+* dict: A dictionary containting service packs assigned in the group.
 
 ### How To Use:
 
@@ -32,68 +32,73 @@ from odins_spear import api
 my_api= api.Api(base_url="https://base_url/api/vx", username="john.smith", password="ODIN_INSTANCE_1")
 my_api.authenticate()
 
-print(
-    my_api.scripter.aa_cc_hg_audit(
-        "serviceProviderId",
-        "groupId"
-    )
+print(my_api.scripter.aa_cc_hg_audit(
+      "serviceProviderId",
+      "groupId"
+   )
 )
 ```
 
 ### Example returned data (formatted):
 
 ```json
 {
-  "auto_attendants": [
-    {
-      "serviceUserId": "my_aa",
-      "services": [
-        {
-          "serviceName": "Alternate Numbers"
-        }
-      ]
-    }
-  ],
-  "call_centers": [
-    {
-      "serviceUserId": "my_cc",
-      "type": "Premium",
-      "services": []
-    },
-    {
-      "serviceUserId": "my_cc_2",
-      "type": "Premium",
-      "services": [
-        {
-          "serviceName": "Call Forwarding Busy",
-          "isActive": false
-        }
-      ]
-    }
-  ],
-  "hunt_groups": [
-    {
-      "serviceUserId": "my_hg_1",
-      "services": [
-        {
-          "serviceName": "Call Forwarding Selective",
-          "isActive": true
-        }
-      ]
-    },
-    {
-      "serviceUserId": "my_hg_2",
-      "services": [
-        {
-          "serviceName": "Call Forwarding Always",
-          "isActive": false
-        }
-      ]
-    },
-    {
-      "serviceUserId": "my_hg_3",
-      "services": []
-    }
-  ]
+   "autoAttendants":[
+      {
+         "serviceUserId":"[email protected]",
+         "type":"Basic",
+         "services":[
+
+         ]
+      }
+   ],
+   "callCenters":[
+      {
+         "serviceUserId":"[email protected]",
+         "type":"Basic",
+         "services":[
+
+         ]
+      }
+   ],
+   "huntGroups":[
+      {
+         "serviceUserId":"[email protected]",
+         "services":[
+
+         ]
+      },
+      {
+         "serviceUserId":"[email protected]",
+         "services":[
+
+         ]
+      },
+      {
+         "serviceUserId":"[email protected]",
+         "services":[
+
+         ]
+      },
+      {
+         "serviceUserId":"[email protected]",
+         "services":[
+
+         ]
+      },
+      {
+         "serviceUserId":"[email protected]",
+         "services":[
+
+         ]
+      },
+      {
+         "serviceUserId":"[email protected]",
+         "services":[
+
+         ]
+      }
+   ]
 }
+
 ```
diff --git a/docs/docs/features/scripter/bulk-password-reset.md b/docs/docs/features/scripter/bulk-password-reset.md
@@ -36,7 +36,7 @@ api.put.user_web_authentication_password()
 
 ### Return
 
-* JSON: Returns JSON containing user ID and new password set.
+* Jdict: Returns dictionary containing user ID and new password set.
 
 ### How To Use:
 
@@ -82,17 +82,17 @@ my_api.scripter.bulk_password_reset(
 
 ```json
 [
-    {
-        "userId": "testuser1@domain.com",
-        "newPassword": "8H]}3y"
-    },
-    {
-        "userId": "testuser2@domain.com",
-        "newPassword": "@734mC"
-    },
-    {
-        "userId": "testuser3@domain.com",
-        "newPassword": "b6V_@%"
-    }
+   {
+      "userId":"User1@domain.com",
+      "newPassword":"3h1U[-"
+   },
+   {
+      "userId":"User2@domain.com",
+      "newPassword":"e^Bv4c"
+   },
+   {
+      "userId":"User3@domain.com",
+      "newPassword":"4WK#:y"
+   }
 ]
 ```
diff --git a/docs/docs/features/scripter/find-alias-script.md b/docs/docs/features/scripter/find-alias-script.md
@@ -9,7 +9,7 @@ The search is conducted in two phases:
 1. Collecting details of AAs, HGs, and CCs and checking for the aliases.
 2. If not found, search through the users for the alias.
 
-If the alias is found, the method returns a string specifying the type of entity and its name or userID. If the alias is not found after checking all entities, an AOAliasNotFound exception is raised.
+If the alias is found, the method returns a dict specifying the type of entity and its name or userID. If the alias is not found after checking all entities, an AOAliasNotFound exception is raised.
 
 The script makes use of the following methods:
 
@@ -31,7 +31,7 @@ api.get.users()
 
 ### Return
 
-* Returns type and name/ userId of entity where alias located.
+* dict: Returns dictionary with type, userserviceid, name and alias.
 
 ### Raise
 
@@ -47,20 +47,19 @@ my_api = api.Api(base_url="https://base_url/api/vx", username="john.smith", pass
 my_api.authenticate()
 
 # find alias method
-print(magic.scripter.find_alias('Service Provider ID', 'Group ID', alias=11))
+print(my_api.scripter.find_alias('Service Provider ID', 'Group ID', alias=12))
 ```
 {% endcode %}
 
-### Terminal Output
-
-{% code overflow="wrap" fullWidth="false" %}
-```
-Fetching AA, HG, and CC details: 100%|██████████████████████████████████████████████████████████████████████████
-Searching AA, HG, and CC for alias 11: 100%|████████████████████████████████████████████████████████████████████
-2024-01-03 13:05:33,003 - INFO - Fetched users.
-Searching Users for alias: 11:  38%|███████████████████████████████████████████████▎                            
-
-        Alias (11) found: User - [email protected]
-        
-```
-{% endcode %}
+### Formatted Output
+
+```json
+{
+   "type":"HG",
+   "service_user_id":"TESTHG",
+   "name":"Test HG",
+   "aliases":[
+      "12@PROXYADDRESS"
+   ]
+}
+```
diff --git a/docs/docs/features/scripter/group-audit.md b/docs/docs/features/scripter/group-audit.md
@@ -32,7 +32,7 @@ api.get.group_trunk_groups_call_capacity()
 
 ### Return
 
-* JSON: json structure containing all the information
+* dict: Returns dictionary containing all group information. Including Users, Group DNs, Group Services, User Services, User Service Packs, Trunking Capacity.
 
 ### How To Use: