Skip to content

Commit f68ebe1

Browse files
ruslanlazinruslanlazin
authored
Merge pull request #31 from QualityUnit/rlazin/listenCall
Listen call. Regenerate API with updated LA endpoints
2 parents 4196a87 + 0ffcbd1 commit f68ebe1

17 files changed

Lines changed: 682 additions & 200 deletions

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,6 @@ Class | Method | HTTP request | Description
127127
*CallsApi* | [**call_remove_channel**](docs/CallsApi.md#call_remove_channel) | **DELETE** /calls/{callId}/channels/{channelId} | Removes channel from the call
128128
*CallsApi* | [**call_reroute**](docs/CallsApi.md#call_reroute) | **POST** /calls/{callId}/_reroute | Let the call ring to another agent
129129
*CallsApi* | [**call_ring**](docs/CallsApi.md#call_ring) | **POST** /calls/{callId}/_ring | Let the call ring
130-
*CallsApi* | [**call_start**](docs/CallsApi.md#call_start) | **POST** /call/_start | Starts new outcoming / internal call
131130
*CallsApi* | [**call_start_canceled**](docs/CallsApi.md#call_start_canceled) | **POST** /call/_startCanceled | Callback that starting call canceled
132131
*CallsApi* | [**call_start_failed**](docs/CallsApi.md#call_start_failed) | **POST** /call/_startFailed | Callback that starting call failed
133132
*CallsApi* | [**call_stop**](docs/CallsApi.md#call_stop) | **POST** /calls/{callId}/_stop | Stops the call
@@ -139,6 +138,8 @@ Class | Method | HTTP request | Description
139138
*CallsApi* | [**get_calls_list**](docs/CallsApi.md#get_calls_list) | **GET** /calls | Gets list of calls
140139
*CallsApi* | [**hold_channel**](docs/CallsApi.md#hold_channel) | **POST** /calls/{callId}/channels/{channelId}/_hold | Hold channel
141140
*CallsApi* | [**mute_channel**](docs/CallsApi.md#mute_channel) | **POST** /calls/{callId}/channels/{channelId}/_mute | Mute channel
141+
*CallsApi* | [**start_call_listening**](docs/CallsApi.md#start_call_listening) | **POST** /calls/{callId}/start_listen | Register agent started listening to the call
142+
*CallsApi* | [**stop_call_listening**](docs/CallsApi.md#stop_call_listening) | **POST** /calls/{callId}/stop_listen | Register agent stopped listening to the call
142143
*CallsApi* | [**stop_ring**](docs/CallsApi.md#stop_ring) | **POST** /calls/{callId}/_stopRing | Stop ringing of call
143144
*CallsApi* | [**unhold_channel**](docs/CallsApi.md#unhold_channel) | **POST** /calls/{callId}/channels/{channelId}/_unhold | Unhold channel
144145
*CallsApi* | [**unmute_channel**](docs/CallsApi.md#unmute_channel) | **POST** /calls/{callId}/channels/{channelId}/_unmute | Unmute channel
@@ -395,6 +396,7 @@ Class | Method | HTTP request | Description
395396
- [SlackUser](docs/SlackUser.md)
396397
- [StoredFile](docs/StoredFile.md)
397398
- [Tag](docs/Tag.md)
399+
- [TagRequest](docs/TagRequest.md)
398400
- [TagRow](docs/TagRow.md)
399401
- [Ticket](docs/Ticket.md)
400402
- [TicketAttribute](docs/TicketAttribute.md)

‎docs/CallsApi.md‎

Lines changed: 118 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Method | HTTP request | Description
1818
[**call_remove_channel**](CallsApi.md#call_remove_channel) | **DELETE** /calls/{callId}/channels/{channelId} | Removes channel from the call
1919
[**call_reroute**](CallsApi.md#call_reroute) | **POST** /calls/{callId}/_reroute | Let the call ring to another agent
2020
[**call_ring**](CallsApi.md#call_ring) | **POST** /calls/{callId}/_ring | Let the call ring
21-
[**call_start**](CallsApi.md#call_start) | **POST** /call/_start | Starts new outcoming / internal call
2221
[**call_start_canceled**](CallsApi.md#call_start_canceled) | **POST** /call/_startCanceled | Callback that starting call canceled
2322
[**call_start_failed**](CallsApi.md#call_start_failed) | **POST** /call/_startFailed | Callback that starting call failed
2423
[**call_stop**](CallsApi.md#call_stop) | **POST** /calls/{callId}/_stop | Stops the call
@@ -30,6 +29,8 @@ Method | HTTP request | Description
3029
[**get_calls_list**](CallsApi.md#get_calls_list) | **GET** /calls | Gets list of calls
3130
[**hold_channel**](CallsApi.md#hold_channel) | **POST** /calls/{callId}/channels/{channelId}/_hold | Hold channel
3231
[**mute_channel**](CallsApi.md#mute_channel) | **POST** /calls/{callId}/channels/{channelId}/_mute | Mute channel
32+
[**start_call_listening**](CallsApi.md#start_call_listening) | **POST** /calls/{callId}/start_listen | Register agent started listening to the call
33+
[**stop_call_listening**](CallsApi.md#stop_call_listening) | **POST** /calls/{callId}/stop_listen | Register agent stopped listening to the call
3334
[**stop_ring**](CallsApi.md#stop_ring) | **POST** /calls/{callId}/_stopRing | Stop ringing of call
3435
[**unhold_channel**](CallsApi.md#unhold_channel) | **POST** /calls/{callId}/channels/{channelId}/_unhold | Unhold channel
3536
[**unmute_channel**](CallsApi.md#unmute_channel) | **POST** /calls/{callId}/channels/{channelId}/_unmute | Unmute channel
@@ -857,67 +858,6 @@ Name | Type | Description | Notes
857858

858859
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
859860

860-
# **call_start**
861-
> OkResponse call_start(to_number, ticket_id, via_number=via_number)
862-
863-
Starts new outcoming / internal call
864-
865-
Starts a new call by ringing the agent and dialing the customer after the agent has picked up the call
866-
867-
### Example
868-
```python
869-
from __future__ import print_function
870-
import time
871-
import liveagent_api
872-
from liveagent_api.rest import ApiException
873-
from pprint import pprint
874-
875-
# Configure API key authorization: apikey
876-
configuration = liveagent_api.Configuration()
877-
configuration.api_key['apikey'] = 'YOUR_API_KEY'
878-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
879-
# configuration.api_key_prefix['apikey'] = 'Bearer'
880-
# Configure OAuth2 access token for authorization: privileges
881-
configuration = liveagent_api.Configuration()
882-
configuration.access_token = 'YOUR_ACCESS_TOKEN'
883-
884-
# create an instance of the API class
885-
api_instance = liveagent_api.CallsApi(liveagent_api.ApiClient(configuration))
886-
to_number = 'to_number_example' # str | callee number
887-
ticket_id = 'ticket_id_example' # str | ticket id or code
888-
via_number = 'via_number_example' # str | trunk number via which call was made (optional)
889-
890-
try:
891-
# Starts new outcoming / internal call
892-
api_response = api_instance.call_start(to_number, ticket_id, via_number=via_number)
893-
pprint(api_response)
894-
except ApiException as e:
895-
print("Exception when calling CallsApi->call_start: %s\n" % e)
896-
```
897-
898-
### Parameters
899-
900-
Name | Type | Description | Notes
901-
------------- | ------------- | ------------- | -------------
902-
**to_number** | **str**| callee number |
903-
**ticket_id** | **str**| ticket id or code |
904-
**via_number** | **str**| trunk number via which call was made | [optional]
905-
906-
### Return type
907-
908-
[**OkResponse**](OkResponse.md)
909-
910-
### Authorization
911-
912-
[apikey](../README.md#apikey), [privileges](../README.md#privileges)
913-
914-
### HTTP request headers
915-
916-
- **Content-Type**: application/x-www-form-urlencoded
917-
- **Accept**: application/json
918-
919-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
920-
921861
# **call_start_canceled**
922862
> OkResponse call_start_canceled(call_id)
923863
@@ -1561,6 +1501,122 @@ Name | Type | Description | Notes
15611501

15621502
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
15631503

1504+
# **start_call_listening**
1505+
> OkResponse start_call_listening(call_id, agent_id=agent_id, channel_id=channel_id)
1506+
1507+
Register agent started listening to the call
1508+
1509+
### Example
1510+
```python
1511+
from __future__ import print_function
1512+
import time
1513+
import liveagent_api
1514+
from liveagent_api.rest import ApiException
1515+
from pprint import pprint
1516+
1517+
# Configure API key authorization: apikey
1518+
configuration = liveagent_api.Configuration()
1519+
configuration.api_key['apikey'] = 'YOUR_API_KEY'
1520+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1521+
# configuration.api_key_prefix['apikey'] = 'Bearer'
1522+
# Configure OAuth2 access token for authorization: privileges
1523+
configuration = liveagent_api.Configuration()
1524+
configuration.access_token = 'YOUR_ACCESS_TOKEN'
1525+
1526+
# create an instance of the API class
1527+
api_instance = liveagent_api.CallsApi(liveagent_api.ApiClient(configuration))
1528+
call_id = 'call_id_example' # str |
1529+
agent_id = 'agent_id_example' # str | listening agent (optional)
1530+
channel_id = 'channel_id_example' # str | listening channel (optional)
1531+
1532+
try:
1533+
# Register agent started listening to the call
1534+
api_response = api_instance.start_call_listening(call_id, agent_id=agent_id, channel_id=channel_id)
1535+
pprint(api_response)
1536+
except ApiException as e:
1537+
print("Exception when calling CallsApi->start_call_listening: %s\n" % e)
1538+
```
1539+
1540+
### Parameters
1541+
1542+
Name | Type | Description | Notes
1543+
------------- | ------------- | ------------- | -------------
1544+
**call_id** | **str**| |
1545+
**agent_id** | **str**| listening agent | [optional]
1546+
**channel_id** | **str**| listening channel | [optional]
1547+
1548+
### Return type
1549+
1550+
[**OkResponse**](OkResponse.md)
1551+
1552+
### Authorization
1553+
1554+
[apikey](../README.md#apikey), [privileges](../README.md#privileges)
1555+
1556+
### HTTP request headers
1557+
1558+
- **Content-Type**: application/json
1559+
- **Accept**: application/json
1560+
1561+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1562+
1563+
# **stop_call_listening**
1564+
> OkResponse stop_call_listening(call_id, channel_id=channel_id)
1565+
1566+
Register agent stopped listening to the call
1567+
1568+
### Example
1569+
```python
1570+
from __future__ import print_function
1571+
import time
1572+
import liveagent_api
1573+
from liveagent_api.rest import ApiException
1574+
from pprint import pprint
1575+
1576+
# Configure API key authorization: apikey
1577+
configuration = liveagent_api.Configuration()
1578+
configuration.api_key['apikey'] = 'YOUR_API_KEY'
1579+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1580+
# configuration.api_key_prefix['apikey'] = 'Bearer'
1581+
# Configure OAuth2 access token for authorization: privileges
1582+
configuration = liveagent_api.Configuration()
1583+
configuration.access_token = 'YOUR_ACCESS_TOKEN'
1584+
1585+
# create an instance of the API class
1586+
api_instance = liveagent_api.CallsApi(liveagent_api.ApiClient(configuration))
1587+
call_id = 'call_id_example' # str |
1588+
channel_id = 'channel_id_example' # str | listening channel (optional)
1589+
1590+
try:
1591+
# Register agent stopped listening to the call
1592+
api_response = api_instance.stop_call_listening(call_id, channel_id=channel_id)
1593+
pprint(api_response)
1594+
except ApiException as e:
1595+
print("Exception when calling CallsApi->stop_call_listening: %s\n" % e)
1596+
```
1597+
1598+
### Parameters
1599+
1600+
Name | Type | Description | Notes
1601+
------------- | ------------- | ------------- | -------------
1602+
**call_id** | **str**| |
1603+
**channel_id** | **str**| listening channel | [optional]
1604+
1605+
### Return type
1606+
1607+
[**OkResponse**](OkResponse.md)
1608+
1609+
### Authorization
1610+
1611+
[apikey](../README.md#apikey), [privileges](../README.md#privileges)
1612+
1613+
### HTTP request headers
1614+
1615+
- **Content-Type**: application/json
1616+
- **Accept**: application/json
1617+
1618+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1619+
15641620
# **stop_ring**
15651621
> OkResponse stop_ring(call_id)
15661622

‎docs/CustomFields.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**code** | **str** | | [optional]
7-
**value** | **str** | | [optional]
6+
**code** | **str** | |
7+
**value** | **str** | |
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

‎docs/MessageGroup.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**parent_id** | **str** | | [optional]
88
**userid** | **str** | | [optional]
99
**user_full_name** | **str** | | [optional]
10-
**type** | **str** | M - OFFLINE_LEGACY C - CHAT P - CALL V - OUTGOING_CALL 1 - INTERNAL_CALL I - INTERNAL U - INTERNAL_OFFLINE Z - INTERNAL_COLLAPSED S - STARTINFO T - TRANSFER R - RESOLVE J - POSTPONE X - DELETE B - SPAM G - TAG F - FACEBOOK W - TWITTER Y - RETWEET A - KNOWLEDGEBASE_START K - KNOWLEDGEBASE O - FORWARD Q - FORWARD_REPLY L - SPLITTED 2 - MERGED 3 - INCOMING_EMAIL 4 - OUTGOING_EMAIL 5 - OFFLINE 6 - TYPE_WHATSAPP 7 - TYPE_RECEIVED_ANSWER | [optional]
10+
**type** | **str** | M - OFFLINE_LEGACY C - CHAT P - CALL V - OUTGOING_CALL 1 - INTERNAL_CALL I - INTERNAL U - INTERNAL_OFFLINE Z - INTERNAL_COLLAPSED S - STARTINFO T - TRANSFER R - RESOLVE J - POSTPONE X - DELETE B - SPAM G - TAG F - FACEBOOK W - TWITTER Y - RETWEET A - KNOWLEDGEBASE_START K - KNOWLEDGEBASE O - FORWARD Q - FORWARD_REPLY L - SPLITTED 2 - MERGED 3 - INCOMING_EMAIL 4 - OUTGOING_EMAIL 5 - OFFLINE 6 - TYPE_WHATSAPP 7 - TYPE_RECEIVED_ANSWER 8 - TYPE_INSTANT_MESSAGE | [optional]
1111
**status** | **str** | D - DELETED P - PROMOTED V - VISIBLE S - SPLITTED M - MERGED I - INITIALIZING R - CONNECTING C - CALLING | [optional]
1212
**datecreated** | **datetime** | | [optional]
1313
**datefinished** | **datetime** | | [optional]

‎docs/TagRequest.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# TagRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **str** | | [optional]
7+
**name** | **str** | |
8+
**color** | **str** | | [optional]
9+
**background_color** | **str** | | [optional]
10+
**is_public** | **str** | - Y - Public tag - N - Private tag | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

‎docs/TagsApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
3737

3838
# create an instance of the API class
3939
api_instance = liveagent_api.TagsApi(liveagent_api.ApiClient(configuration))
40-
tag = liveagent_api.Tag() # Tag | (optional)
40+
tag = liveagent_api.TagRequest() # TagRequest | (optional)
4141

4242
try:
4343
# Create tag
@@ -51,7 +51,7 @@ except ApiException as e:
5151

5252
Name | Type | Description | Notes
5353
------------- | ------------- | ------------- | -------------
54-
**tag** | [**Tag**](Tag.md)| | [optional]
54+
**tag** | [**TagRequest**](TagRequest.md)| | [optional]
5555

5656
### Return type
5757

@@ -256,7 +256,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
256256
# create an instance of the API class
257257
api_instance = liveagent_api.TagsApi(liveagent_api.ApiClient(configuration))
258258
tag_id = 'tag_id_example' # str |
259-
tag = liveagent_api.Tag() # Tag | (optional)
259+
tag = liveagent_api.TagRequest() # TagRequest | (optional)
260260

261261
try:
262262
# Update tag
@@ -271,7 +271,7 @@ except ApiException as e:
271271
Name | Type | Description | Notes
272272
------------- | ------------- | ------------- | -------------
273273
**tag_id** | **str**| |
274-
**tag** | [**Tag**](Tag.md)| | [optional]
274+
**tag** | [**TagRequest**](TagRequest.md)| | [optional]
275275

276276
### Return type
277277

‎docs/TicketRow.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
2020
**preview** | **str** | | [optional]
2121
**subject** | **str** | | [optional]
2222
**departmentname** | **str** | | [optional]
23+
**is_department_archived** | **bool** | | [optional]
2324
**agentname** | **str** | | [optional]
2425
**tags** | **list[str]** | | [optional]
2526
**messagegroups_in** | **float** | | [optional]

‎liveagent_api/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@
151151
from liveagent_api.models.slack_user import SlackUser
152152
from liveagent_api.models.stored_file import StoredFile
153153
from liveagent_api.models.tag import Tag
154+
from liveagent_api.models.tag_request import TagRequest
154155
from liveagent_api.models.tag_row import TagRow
155156
from liveagent_api.models.ticket import Ticket
156157
from liveagent_api.models.ticket_attribute import TicketAttribute

0 commit comments

Comments
 (0)