Merge pull request #35 from Jordan-Prescott/docs

Docs - Update to Find Alias

docs/features/reporter/call-flow.md

@@ -4,7 +4,7 @@ Generates a visual call flow for a dedicated number for example calls to 0.
 
 There is now no need to spend hours interrogating how calls to 0 flows through your Braodworks/ Odin system building a call flow for management or to send to customers. This can now be done in seconds with Odins Spear Reporter. Give this feature the number (0), the number type (DN, Extension, Alias), and what its attached to (User, Hunt Group etc) and the feature will generate a flow like the below for you!
 
-<figure><img src="../../../.gitbook/assets/image (21).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/image (29).png" 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
 

docs/features/reporter/help/abbreviation-key.md

@@ -6,7 +6,7 @@ description: >-
 
 # 🔑 Abbreviation Key
 
-<figure><img src="../../../../.gitbook/assets/image (17).png" alt=""><figcaption><p>Example of Call Flow showing abbreviations.</p></figcaption></figure>
+<figure><img src="../../../../.gitbook/assets/image (25).png" alt=""><figcaption><p>Example of Call Flow showing abbreviations.</p></figcaption></figure>
 
 | Abbreviation | Meaning                           |
 | ------------ | --------------------------------- |

docs/features/reporter/help/node-key.md

@@ -2,7 +2,7 @@
 
 ## Call Flow Nodes
 
-<figure><img src="../../../../.gitbook/assets/image (18).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/image (26).png" 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>
 

docs/features/scripter/aa-cc-hg-audit.md

@@ -2,17 +2,17 @@
 description: my_api.scripter.aa_cc_hg_audit()
 ---
 
-# ✔ AA, CC, HG Audit
+# ✔️ AA, CC, HG Audit
 
 This script returns the services assigned to Auto Attendants, Call Centres, and Hunt Groups. Only services are applied to these entities and there are scenarios one would need to focus services assigned to these entities.
 
 The script makes use of the following methods:
 
 ```python
-api.get.auto_attendants(service_provider_id, group_id)
-api.get.group_call_centers(service_provider_id, group_id)
-api.get.group_hunt_groups(service_provider_id, group_id)
-api.get.user_services_assigned(user_id)
+api.get.auto_attendants()
+api.get.group_call_centers()
+api.get.group_hunt_groups()
+api.get.user_services_assigned()
 ```
 
 ### Parameters 

docs/features/scripter/find-alias-script.md

@@ -11,6 +11,18 @@ The search is conducted in two phases:
 
 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.
 
+The script makes use of the following methods:
+
+```python
+api.get.auto_attendants()
+api.get.auto_attendant()
+api.get.group_hunt_groups()
+api.get.group_hunt_group()
+api.get.call_centers()
+api.get.call_center()
+api.get.users()
+```
+
 ### Parameters 
 
 * service\_provider\_id: Service Prodiver where group is hosted.

docs/features/scripter/service-pack-audit.md

@@ -8,7 +8,7 @@ A stripped down version of group audit focussing only on the service packs assig
 
 The script makes use of the following methods:
 
-<pre class="language-python"><code class="lang-python"><strong>api.get.group_services(group_id, service_provider_id)
+<pre class="language-python"><code class="lang-python"><strong>api.get.group_services()
 </strong></code></pre>
 
 ### Parameters&#x20;

docs/getting-started/downloading-library-beta.md

@@ -1,4 +1,4 @@
-# ⬇ Downloading Library (BETA)
+# ⬇️ Downloading Library (BETA)
 
 First browse to the GitHub repo.
 
@@ -10,7 +10,7 @@ Next, click the green '_<> Code'_ button and then '_Download ZIP'._
 
 Once the code is downloaded, extract the files from the zipped file and locate the folder _'odin\_api'_ the file _'requirements.txt'._ These are the only files and folders you need to use the library, the others can be removed.&#x20;
 
-<figure><img src="../../.gitbook/assets/image (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (3).png" alt=""><figcaption></figcaption></figure>
 
 Staying in the same folder opens a new machine terminal, one method to do this is from your folder view click the blue file in the top right-hand corner and select 'O_pen Windows PowerShell'._ Next you need to install the requirements for the library, run the below command to do this.
 
@@ -20,7 +20,7 @@ pip install -r requirements.txt
 
 Finally, place that folder where you would like to write code that uses the library and import the library in your Python files.&#x20;
 
-<figure><img src="../../.gitbook/assets/image (2) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (4).png" alt=""><figcaption></figcaption></figure>
 
 {% hint style="info" %}
 While the library is in development this is the current way to use it. Please note this will change once version 0.1.0 is released.

docs/getting-started/setting-environment-variable.md

@@ -8,7 +8,7 @@ Before using the library set up an environment variable in your local machine an
 
 Setting environment variable (Windows):
 
-<figure><img src="../../.gitbook/assets/image (4).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (6).png" alt=""><figcaption></figcaption></figure>
 
 Passing environment variable to API object:
 

docs/methods/call-centers/group-call-center-status.md

@@ -2,7 +2,7 @@
 description: my_api.put.group_call_centers_status()
 ---
 
-# 🟢 Group Call Center Status
+# 🟢 PUT - Group Call Center Status
 
 In this method, you can control the status of your Call Centers (CC) by activating and deactivating them. The method takes in two parameters, they are a list of the CC service user IDs and a status which is a boolean value of True (Active) or False (Deactivate).
 
@@ -39,5 +39,5 @@ my_api.put.group_call_centers_status(
 
 #### Result:
 
-<figure><img src="../../../../.gitbook/assets/image (5).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (13).png" alt=""><figcaption></figcaption></figure>
 

docs/methods/call-centers/group-call-center.md

@@ -2,7 +2,7 @@
 description: my_api.put.group_call_centers()
 ---
 
-# 🎧 Group Call Center
+# 🎧 PUT - Group Call Center
 
 In this method, you can control the status of your Call Centers (CC) by activating and deactivating them. The method takes in two parameters, they are a list of the CC service user IDs and a status which is a boolean value of True (Active) or False (Deactivate).
 
@@ -39,5 +39,5 @@ my_api.put.group_call_centers_status(
 
 #### Result:
 
-<figure><img src="../../../../.gitbook/assets/image (5).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (13).png" alt=""><figcaption></figcaption></figure>