Aa cc aa online docs (#88)

docs/SUMMARY.md

@@ -82,7 +82,17 @@
       * [🟢 PUT - Auto Attendant Status](docs/methods/auto-attendants/auto-attendant-status.md)
       * [🍅 PUT - Auto Attendant](docs/methods/auto-attendants/auto-attendant.md)
       * [📖 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)
     * [📞 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)
+      * [👤 GET - User Call Center](docs/methods/call-centers/get-user-call-center.md)
+      * [📞 GET - Group Call Center Bounced Calls](docs/methods/call-centers/get-group-call-center-bounced-calls.md)
+      * [📞 GET - Group Call Center Forced Forwarding](docs/methods/call-centers/get-group-call-center-forced-forwarding.md)
+      * [📞 GET - Group Call Center Overflow](docs/methods/call-centers/get-group-call-center-overflow.md)
+      * [🆘 GET - Group Call Center Stranded Calls](docs/methods/call-centers/get-group-call-center-stranded-calls.md)
+      * [🚫 GET - Group Call Center Stranded Calls Unavailable](docs/methods/call-centers/get-group-call-center-stranded-calls-unavailable.md)
       * [🟢 PUT - Group Call Center Status](docs/methods/call-centers/group-call-center-status.md)
       * [🎧 PUT - Group Call Center](docs/methods/call-centers/group-call-center.md)
       * [🎧 PUT - Group Call Center Agents](docs/methods/call-centers/group-call-center-agents.md)
@@ -115,6 +125,9 @@
       * [🎐 PUT - Service Provider Device Type Tag](docs/methods/devices/service-provider-device-type-tag.md)
       * [🗃️ POST - Group Device](docs/methods/devices/post-group\_device.md)
     * [🍇 Hunt Groups](docs/methods/hunt-groups/README.md)
+      * [🍇 GET - Group Hunt Groups](docs/methods/hunt-groups/get-group-hunt-groups.md)
+      * [🍊 GET - Group Hunt Group](docs/methods/hunt-groups/get-group-hunt-group.md)
+      * [🍐 GET - Group Hunt Group User](docs/methods/hunt-groups/get-group-hunt-group-user.md)
       * [🟢 PUT - Group Hunt Groups Status](docs/methods/hunt-groups/group-hunt-groups-status.md)
       * [🍏 PUT - Group Hunt Group](docs/methods/hunt-groups/group-hunt-group.md)
       * [💯 PUT - Group Hunt Group Weighted Call Distribution](docs/methods/hunt-groups/group-hunt-group-weighted-call-distribution.md)

docs/docs/methods/auto-attendants/auto-attendant.md

@@ -8,31 +8,47 @@ In this method, you can update your AAs 
 
 ### Parameters 
 
-* auto\_attendant\_user\_ids (list): List of service user IDs (AA IDs), the status given will be applied to these.
-* status (bool): Boolean value of True (Activate) or False (Deactivate) which will be applied to list of AAs.
+* service_provider_id (str): Service Provider ID where Group is hosted.
+* group_id (str): Group ID where target Auto Attendant is located.
+* auto_attendant_user_id (str): Target Auto Attendant User ID.
+* updates (dict): Updates to be applied to Auto Attendant.
 
 ### Return
 
-* JSON Data: This method returns json representation of AA updated.
+* Dict: Updated version of the Auto Attendant with updates applied. 
 
 ### How To Use:
 
-The below code will set the AA to deactivated.
-
 {% code overflow="wrap" %}
 ```python
 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()
 
-auto_attendants = [
-    "[email protected]"
-]
-
-my_api.put.auto_attendants_status(
-    auto_attendant_user_ids= auto_attendants,
-    status= False
+my_changes = {
+    "serviceInstanceProfile": {
+    "name": "Name of Auto Attendant",
+    "callingLineIdLastName": "Auto Attendant",
+    "callingLineIdFirstName": "Main",
+    "hiraganaLastName": "mock-aa-test-1",
+    "hiraganaFirstName": "Auto Attendant",
+    "language": "English",
+    "timeZone": "America/Denver",
+    "timeZoneDisplayName": "(GMT-06:00) (US) Mountain Time",
+    "aliases": []
+  },
+  "type": "Basic",
+  "enableVideo": False,
+  "extensionDialingScope": "Group",
+  "nameDialingScope": "Group",
+}
+
+my_api.put.auto_attendant(
+    service_provider_id="serviceProviderID",
+    group_id="groupID"
+    auto_attendant_user_id="AAUserID",
+    updates=my_changes
 )
 ```
 {% endcode %}

docs/docs/methods/auto-attendants/get-auto-attendant.md

@@ -0,0 +1,111 @@
+---
+description: my_api.get.auto_attendant()
+---
+
+#  🤙🏼 GET - Auto Attendant
+
+Returns detailed information of a singel Auto Attendant.
+
+### Parameters 
+
+* service_user_id (str): User ID of target Auto Attendant.
+
+### Returns
+
+* dict: Detailed information of target Auto Attendant.
+
+### How To Use:
+
+{% code overflow="wrap" %}
+```python
+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()
+
+
+my_api.get.auto_attendant(
+    service_user_id="auto_attendant_user_id"
+)
+```
+{% endcode %}
+
+### Example Returned Data (Formatted)
+```json
+{
+  "serviceInstanceProfile": {
+    "name": "mock-aa-test-1",
+    "callingLineIdLastName": "mock-aa-test-1",
+    "callingLineIdFirstName": "mock-aa-test-1",
+    "hiraganaLastName": "mock-aa-test-1",
+    "hiraganaFirstName": "Auto Attendant",
+    "language": "English",
+    "timeZone": "America/Denver",
+    "timeZoneDisplayName": "(GMT-06:00) (US) Mountain Time",
+    "aliases": []
+  },
+  "type": "Basic",
+  "enableVideo": false,
+  "extensionDialingScope": "Group",
+  "nameDialingScope": "Group",
+  "nameDialingEntries": "LastName + FirstName",
+  "businessHoursMenu": {
+    "announcementSelection": "Default",
+    "enableFirstMenuLevelExtensionDialing": false,
+    "keys": [
+      {
+        "key": "0",
+        "action": "Transfer To Operator",
+        "description": null,
+        "phoneNumber": null,
+        "submenuId": null
+      },
+      {
+        "key": "1",
+        "action": "Extension Dialing",
+        "description": null,
+        "phoneNumber": null,
+        "submenuId": null
+      },
+      {
+        "key": "2",
+        "action": "Name Dialing",
+        "description": null,
+        "phoneNumber": null,
+        "submenuId": null
+      }
+    ]
+  },
+  "afterHoursMenu": {
+    "announcementSelection": "Default",
+    "enableFirstMenuLevelExtensionDialing": false,
+    "keys": [
+      {
+        "key": "0",
+        "action": "Transfer To Operator",
+        "description": null,
+        "phoneNumber": null,
+        "submenuId": null
+      },
+      {
+        "key": "1",
+        "action": "Extension Dialing",
+        "description": null,
+        "phoneNumber": null,
+        "submenuId": null
+      },
+      {
+        "key": "2",
+        "action": "Name Dialing",
+        "description": null,
+        "phoneNumber": null,
+        "submenuId": null
+      }
+    ]
+  },
+  "serviceUserId": "mock-aa-test-1",
+  "serviceProviderId": "odin.mock.ent1",
+  "groupId": "odin.mock.grp1",
+  "isEnterprise": true
+}
+```

docs/docs/methods/auto-attendants/get-auto-attendants.md

@@ -0,0 +1,57 @@
+---
+description: my_api.get.auto_attendants()
+---
+
+#  📞 GET - Auto Attendants
+
+Returns a complete list of all Auto Attendants in a single group.
+
+### Parameters 
+
+* service_provider_id (str): Service Provider where Group is hosted.
+* group_id (str): Target Group where Auto Attendants are hosted.
+### Returns
+
+* List: List of Auto Attendants with basic info on them.
+
+### How To Use:
+
+{% code overflow="wrap" %}
+```python
+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()
+
+my_api.get.auto_attendants(
+    service_provider_id="serviceProviderId",
+    group_id="groupId"
+)
+```
+{% endcode %}
+
+### Example Returned Data (Formatted)
+```json
+[
+  {
+    "serviceUserId": "testAA",
+    "name": "My Test AA",
+    "video": false,
+    "phoneNumber": 123456789,
+    "extension": "6060",
+    "department": "Department Name",
+    "isActive": true,
+    "type": "Basic"
+  },
+  {
+    "serviceUserId": "OtherAA",
+    "name": "Another AA",
+    "video": false,
+    "phoneNumber": null,
+    "extension": null,
+    "department": null,
+    "isActive": true,
+    "type": "Basic"
+  }
+]
+```

docs/docs/methods/call-centers/get-group-call-center-bounced-calls.md

@@ -0,0 +1,46 @@
+---
+description: my_api.get.group_call_center_bounced_calls()
+---
+
+#  📞 GET - Group Call Center Bounced Calls
+
+Retrieves the number of rings before a call is bounced from the specified call center.
+
+### Parameters 
+
+* service_user_id (str): Target Call Center ID
+
+
+### Returns
+
+* Dict: Amount of Rings before a call is Bounced
+
+### How To Use:
+
+{% code overflow="wrap" %}
+```python
+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()
+
+my_api.get.group_call_center_bounced_calls(
+    service_user_id="[email protected]"
+)
+```
+{% endcode %}
+
+### Example Returned Data (Formatted)
+```json
+{
+  "isActive": true,
+  "numberOfRingsBeforeBouncingCall": 5,
+  "enableTransfer": false,
+  "bounceCallWhenAgentUnavailable": true,
+  "alertCallCenterCallOnHold": true,
+  "alertCallCenterCallOnHoldSeconds": 30,
+  "bounceCallCenterCallOnHold": false,
+  "bounceCallCenterCallOnHoldSeconds": 60,
+  "serviceUserId": "[email protected]"
+}
+```

docs/docs/methods/call-centers/get-group-call-center-forced-forwarding.md

@@ -0,0 +1,53 @@
+---
+description: my_api.get.group_call_center_forced_forwarding()
+---
+
+#  📞 GET - Group Call Center Forced Forwarding
+
+Retrieves the forwarding number for a call center if it is set to forward calls, along with any associated audio messages.
+
+### Parameters 
+
+* service_user_id (str): Target Call Center ID
+
+### Returns
+
+* Dict: Number to be Forwarded to, alongside any Audio Messages.
+
+### How To Use:
+
+{% code overflow="wrap" %}
+```python
+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()
+
+my_api.get.group_call_center_forced_forwarding(
+    service_user_id="[email protected]"
+)
+```
+{% endcode %}
+
+### Example Returned Data (Formatted)
+```json
+{
+  "serviceUserId": "[email protected]",
+  "enabled": false,
+  "forwardToPhoneNumber": null,
+  "allowEnableViaFAC": true,
+  "playAnnouncementBeforeForwarding": false,
+  "audioMessageSource": "File",
+  "videoMessageSource": "Default",
+  "audioUrlList": [],
+  "videoUrlList": [],
+  "audioFileList": [
+    {
+      "name": "HandoverMusic.wav",
+      "mediaType": "WAV",
+      "level": "User"
+    }
+  ],
+  "videoFileList": []
+}
+```