Skip to content

Commit

Permalink
Updated docs (#89)
Browse files Browse the repository at this point in the history
  • Loading branch information
LivCurtis authored Jul 30, 2024
1 parent 5094787 commit ec2845b
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@
* [🚗 GET - User Call Forwarding Selective](docs/methods/call-forwarding/get-user-call-forwarding-selective.md)
* [🧾 Call Records](docs/methods/call-records/README.md)
* [🧾 GET - User Stats](docs/methods/call-records/get-call-stats.md)
* [💬 Call Pickup](docs/methods/call-pickup/README.md)
* [🤳 GET - Call Pickup Group User](docs/methods/call-pickup/get-call-pickup-group-user.md)
* [🔑 Authentication](docs/methods/authentication/README.md)
* [🔏 PUT - User Web Authentication Password](docs/methods/authentication/put-user-web-authentication-password.md)
* [👮‍♀️ PUT - User Authentication Service](docs/methods/authentication/put-user-authentication-service.md)
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/methods/call-pickup/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 💬 Auto Attendants

All things updating auto attendants.
72 changes: 72 additions & 0 deletions docs/docs/methods/call-pickup/get-call-pickup-group-user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
description: my_api.get.call_pickup_group_user()
---

# 🤳 GET - Call Pickup Group User

Retrieves Pickup Group information for the specified user.

### Parameters 

* service_provider_id (str): Target Service Provider ID
* group_id (str): The Target Group ID the user is apart of.
* user_id (str): Target User ID

### Returns

* Dict: Specified users pickup group, and the users within that group.

### 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.put.call_pickup_group_user(
"my_service_provider_id",
"my_group_id",
"[email protected]"
)
```
{% endcode %}

### Example Data Returned (Formatted)

```json

{
"serviceProviderId": "my_service_provider_id",
"groupId": "my_group_id",
"name": "Call Pickup 1",
"users": [
{
"userId": "[email protected]",
"lastName": "Smith",
"firstName": "John",
"hiraganaLastName": "Smith",
"hiraganaFirstName": "John",
"phoneNumber": "+1-23456789",
"extension": "1234",
"department": None,
"emailAddress": None
},
{
"userId": "[email protected]",
"lastName": "Smith",
"firstName": "Jane",
"hiraganaLastName": "Smith",
"hiraganaFirstName": "jane",
"phoneNumber": "+1-98765432",
"extension": "4321",
"department": None,
"emailAddress": None
}
]
}


```

0 comments on commit ec2845b

Please sign in to comment.