Skip to content

Commit 079c92b

Browse files
ruslanlazinruslanlazin
committed
refactor: Regenerate API after adding transfer endpoint to LA
1 parent 377e285 commit 079c92b

18 files changed

Lines changed: 382 additions & 298 deletions

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ Class | Method | HTTP request | Description
117117
*CallsApi* | [**call_add_message**](docs/CallsApi.md#call_add_message) | **POST** /calls/{callId}/messages | Adds a message to the call group in corresponding ticket
118118
*CallsApi* | [**call_add_recording**](docs/CallsApi.md#call_add_recording) | **POST** /calls/{callId}/recordings | Adds a recording to the call group in corresponding ticket
119119
*CallsApi* | [**call_answer**](docs/CallsApi.md#call_answer) | **POST** /calls/{callId}/_answer | Set call as answered by agent
120+
*CallsApi* | [**call_blind_transfer**](docs/CallsApi.md#call_blind_transfer) | **POST** /calls/{callId}_blind_transfer | Transfers call to different department / agent
120121
*CallsApi* | [**call_change_channel_status**](docs/CallsApi.md#call_change_channel_status) | **PUT** /calls/{callId}/channels/{channelId}/_status | Change channel status
121122
*CallsApi* | [**call_create**](docs/CallsApi.md#call_create) | **POST** /calls/{callId} | Create new call
122123
*CallsApi* | [**call_fetch_ivr**](docs/CallsApi.md#call_fetch_ivr) | **POST** /calls/{callId}/_fetchIvr | Fetches IVR for the call from external URL
@@ -251,9 +252,9 @@ Class | Method | HTTP request | Description
251252
*PhonesApi* | [**get_phone**](docs/PhonesApi.md#get_phone) | **GET** /phones/{phoneId} | Gets phone device (use _app_ for LiveAgent Phone app device and _web_ for web device)
252253
*PhonesApi* | [**get_phones_list**](docs/PhonesApi.md#get_phones_list) | **GET** /phones | Gets list of available phone devices. Special filters (userId - filter phones available for specified user only)
253254
*PhonesApi* | [**remove_phone**](docs/PhonesApi.md#remove_phone) | **DELETE** /phones/{phoneId} | Remove phone
255+
*PhonesApi* | [**update_browser_registration**](docs/PhonesApi.md#update_browser_registration) | **PUT** /phones/{phoneId}/_updateBrowserRegistration | Update browser registration status
254256
*PhonesApi* | [**update_phone**](docs/PhonesApi.md#update_phone) | **PUT** /phones/{phoneId} | Update phone
255257
*PhonesApi* | [**update_phone_params**](docs/PhonesApi.md#update_phone_params) | **PUT** /phones/{phoneId}/_updateParams | Update phone params
256-
*PhonesApi* | [**update_reg_status**](docs/PhonesApi.md#update_reg_status) | **PUT** /phones/{phoneId}/_updateRegStatus | Update registration status
257258
*PingApi* | [**ping**](docs/PingApi.md#ping) | **GET** /ping | Check that API is responding
258259
*PredefinedAnswersApi* | [**create_predefined_answer**](docs/PredefinedAnswersApi.md#create_predefined_answer) | **POST** /predefined_answers | Create predefined answer
259260
*PredefinedAnswersApi* | [**delete_predefined_answer**](docs/PredefinedAnswersApi.md#delete_predefined_answer) | **DELETE** /predefined_answers/{predefinedAnswerId} | Predefined answer
@@ -274,7 +275,6 @@ Class | Method | HTTP request | Description
274275
*SlasApi* | [**get_sla_ticket_history**](docs/SlasApi.md#get_sla_ticket_history) | **GET** /slas/{ticketId}/history | Gets ticket sla history
275276
*SlasApi* | [**get_slas_list**](docs/SlasApi.md#get_slas_list) | **GET** /slas | Gets list of slas
276277
*SubscriptionsApi* | [**get_billing_status**](docs/SubscriptionsApi.md#get_billing_status) | **GET** /subscriptions/{subscriptionId}/billingStatus | Billing status
277-
*SubscriptionsApi* | [**get_custom_reseller_upgrade_url**](docs/SubscriptionsApi.md#get_custom_reseller_upgrade_url) | **GET** /subscriptions/{subscriptionId}/upgrade_url | Upgrade Url
278278
*SubscriptionsApi* | [**get_domain_info**](docs/SubscriptionsApi.md#get_domain_info) | **GET** /subscriptions/{subscriptionId}/domain | Domain info
279279
*SubscriptionsApi* | [**get_subscription_discounts**](docs/SubscriptionsApi.md#get_subscription_discounts) | **GET** /subscriptions/{subscriptionId}/discounts | Subscription discounts
280280
*SubscriptionsApi* | [**set_custom_domain**](docs/SubscriptionsApi.md#set_custom_domain) | **PUT** /subscriptions/{subscriptionId}/custom_domain | Custom domain

‎docs/AgentStatus.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
66
**departmentid** | **str** | | [optional]
77
**online_status** | **str** | R - read<br> M - message<br> T - chat<br> P - phone | [optional]
88
**preset_status** | **str** | R - read<br> M - message<br> T - chat<br> P - phone | [optional]
9+
**work_allocation_allowed** | **bool** | | [optional]
910

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

‎docs/CallsApi.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Method | HTTP request | Description
77
[**call_add_message**](CallsApi.md#call_add_message) | **POST** /calls/{callId}/messages | Adds a message to the call group in corresponding ticket
88
[**call_add_recording**](CallsApi.md#call_add_recording) | **POST** /calls/{callId}/recordings | Adds a recording to the call group in corresponding ticket
99
[**call_answer**](CallsApi.md#call_answer) | **POST** /calls/{callId}/_answer | Set call as answered by agent
10+
[**call_blind_transfer**](CallsApi.md#call_blind_transfer) | **POST** /calls/{callId}_blind_transfer | Transfers call to different department / agent
1011
[**call_change_channel_status**](CallsApi.md#call_change_channel_status) | **PUT** /calls/{callId}/channels/{channelId}/_status | Change channel status
1112
[**call_create**](CallsApi.md#call_create) | **POST** /calls/{callId} | Create new call
1213
[**call_fetch_ivr**](CallsApi.md#call_fetch_ivr) | **POST** /calls/{callId}/_fetchIvr | Fetches IVR for the call from external URL
@@ -210,6 +211,67 @@ Name | Type | Description | Notes
210211

211212
[[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)
212213

214+
# **call_blind_transfer**
215+
> Call call_blind_transfer(call_id, to_number, channel_id)
216+
217+
Transfers call to different department / agent
218+
219+
Blind transfer can be called on active calls to transfer them to another pnone device or extension number
220+
221+
### Example
222+
```python
223+
from __future__ import print_function
224+
import time
225+
import liveagent_api
226+
from liveagent_api.rest import ApiException
227+
from pprint import pprint
228+
229+
# Configure API key authorization: apikey
230+
configuration = liveagent_api.Configuration()
231+
configuration.api_key['apikey'] = 'YOUR_API_KEY'
232+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
233+
# configuration.api_key_prefix['apikey'] = 'Bearer'
234+
# Configure OAuth2 access token for authorization: privileges
235+
configuration = liveagent_api.Configuration()
236+
configuration.access_token = 'YOUR_ACCESS_TOKEN'
237+
238+
# create an instance of the API class
239+
api_instance = liveagent_api.CallsApi(liveagent_api.ApiClient(configuration))
240+
call_id = 'call_id_example' # str |
241+
to_number = 'to_number_example' # str | Phone device or extension number
242+
channel_id = 'channel_id_example' # str | Channel ID that initiated the transfer
243+
244+
try:
245+
# Transfers call to different department / agent
246+
api_response = api_instance.call_blind_transfer(call_id, to_number, channel_id)
247+
pprint(api_response)
248+
except ApiException as e:
249+
print("Exception when calling CallsApi->call_blind_transfer: %s\n" % e)
250+
```
251+
252+
### Parameters
253+
254+
Name | Type | Description | Notes
255+
------------- | ------------- | ------------- | -------------
256+
**call_id** | **str**| |
257+
**to_number** | **str**| Phone device or extension number |
258+
**channel_id** | **str**| Channel ID that initiated the transfer |
259+
260+
### Return type
261+
262+
[**Call**](Call.md)
263+
264+
### Authorization
265+
266+
[apikey](../README.md#apikey), [privileges](../README.md#privileges)
267+
268+
### HTTP request headers
269+
270+
- **Content-Type**: application/json
271+
- **Accept**: application/json
272+
273+
[[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)
274+
213275
# **call_change_channel_status**
214276
> OkResponse call_change_channel_status(call_id, channel_id, status)
215277

‎docs/DeviceDepartment.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**department_name** | **str** | | [optional]
1010
**online_status** | **str** | | [optional]
1111
**preset_status** | **str** | | [optional]
12+
**work_allocation_allowed** | **bool** | | [optional]
1213

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

‎docs/PhoneNumber.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**id** | **str** | |
7-
**type** | **str** | A - API controlled number, T - Twilio number, T-O - Twilio outgoing number, D - Digitale, S - Asterisk | [optional]
7+
**type** | **str** | A - API controlled number, T - Twilio number, T-O - Twilio outgoing number, S - Asterisk | [optional]
88
**dial_out_prefix** | **int** | Prefix needed to originate call using this number | [optional]
99
**dial_out_prefix_formatted** | **str** | Dial out prefix in 2 or 3 digits string format according to application settings | [optional]
1010
**record_in_call** | **bool** | | [optional]

‎docs/PhoneNumbersApi.md‎

Lines changed: 2 additions & 2 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.PhoneNumbersApi(liveagent_api.ApiClient(configuration))
40-
type = 'type_example' # str | A - API controlled number, T - Twilio number, T-O - Twilio outgoing number, D - Digitale, S - Asterisk
40+
type = 'type_example' # str | A - API controlled number, T - Twilio number, T-O - Twilio outgoing number, S - Asterisk
4141
number = 'number_example' # str |
4242
status = 'status_example' # str | A - Active, I - Inactive
4343
dial_out_prefix = 56 # int | Prefix needed to originate call using this number (optional)
@@ -69,7 +69,7 @@ except ApiException as e:
6969

7070
Name | Type | Description | Notes
7171
------------- | ------------- | ------------- | -------------
72-
**type** | **str**| A - API controlled number, T - Twilio number, T-O - Twilio outgoing number, D - Digitale, S - Asterisk |
72+
**type** | **str**| A - API controlled number, T - Twilio number, T-O - Twilio outgoing number, S - Asterisk |
7373
**number** | **str**| |
7474
**status** | **str**| A - Active, I - Inactive |
7575
**dial_out_prefix** | **int**| Prefix needed to originate call using this number | [optional]

‎docs/PhonesApi.md‎

Lines changed: 37 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Method | HTTP request | Description
88
[**get_phone**](PhonesApi.md#get_phone) | **GET** /phones/{phoneId} | Gets phone device (use _app_ for LiveAgent Phone app device and _web_ for web device)
99
[**get_phones_list**](PhonesApi.md#get_phones_list) | **GET** /phones | Gets list of available phone devices. Special filters (userId - filter phones available for specified user only)
1010
[**remove_phone**](PhonesApi.md#remove_phone) | **DELETE** /phones/{phoneId} | Remove phone
11+
[**update_browser_registration**](PhonesApi.md#update_browser_registration) | **PUT** /phones/{phoneId}/_updateBrowserRegistration | Update browser registration status
1112
[**update_phone**](PhonesApi.md#update_phone) | **PUT** /phones/{phoneId} | Update phone
1213
[**update_phone_params**](PhonesApi.md#update_phone_params) | **PUT** /phones/{phoneId}/_updateParams | Update phone params
13-
[**update_reg_status**](PhonesApi.md#update_reg_status) | **PUT** /phones/{phoneId}/_updateRegStatus | Update registration status
1414

1515

1616
# **create_phone**
@@ -38,7 +38,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
3838
# create an instance of the API class
3939
api_instance = liveagent_api.PhonesApi(liveagent_api.ApiClient(configuration))
4040
number = 'number_example' # str |
41-
type = 'S' # str | S - SIP phone, E - PSTN phone, R - SIP provider extension (optional) (default to S)
41+
type = 'S' # str | S - SIP phone, E - PSTN phone, R - SIP provider extension, I - API phone (optional) (default to S)
4242
name = 'name_example' # str | (optional)
4343
trunk_id = 8.14 # float | (optional)
4444
agent_id = 'agent_id_example' # str | (optional)
@@ -57,7 +57,7 @@ except ApiException as e:
5757
Name | Type | Description | Notes
5858
------------- | ------------- | ------------- | -------------
5959
**number** | **str**| |
60-
**type** | **str**| S - SIP phone, E - PSTN phone, R - SIP provider extension | [optional] [default to S]
60+
**type** | **str**| S - SIP phone, E - PSTN phone, R - SIP provider extension, I - API phone | [optional] [default to S]
6161
**name** | **str**| | [optional]
6262
**trunk_id** | **float**| | [optional]
6363
**agent_id** | **str**| | [optional]
@@ -255,10 +255,10 @@ Name | Type | Description | Notes
255255

256256
[[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)
257257

258-
# **update_phone**
259-
> PhoneDevice update_phone(phone_id, number=number, name=name, trunk_id=trunk_id, pass_original_caller_id=pass_original_caller_id)
258+
# **update_browser_registration**
259+
> OkResponse update_browser_registration(phone_id, reg_status, user_agent)
260260
261-
Update phone
261+
Update browser registration status
262262

263263
### Example
264264
```python
@@ -280,32 +280,28 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
280280
# create an instance of the API class
281281
api_instance = liveagent_api.PhonesApi(liveagent_api.ApiClient(configuration))
282282
phone_id = 'phone_id_example' # str |
283-
number = 'number_example' # str | (optional)
284-
name = 'name_example' # str | (optional)
285-
trunk_id = 56 # int | (optional)
286-
pass_original_caller_id = 'pass_original_caller_id_example' # str | (optional)
283+
reg_status = 'reg_status_example' # str | F - Phone is not registered (offline). N - Phone is registered (online).
284+
user_agent = 'user_agent_example' # str |
287285

288286
try:
289-
# Update phone
290-
api_response = api_instance.update_phone(phone_id, number=number, name=name, trunk_id=trunk_id, pass_original_caller_id=pass_original_caller_id)
287+
# Update browser registration status
288+
api_response = api_instance.update_browser_registration(phone_id, reg_status, user_agent)
291289
pprint(api_response)
292290
except ApiException as e:
293-
print("Exception when calling PhonesApi->update_phone: %s\n" % e)
291+
print("Exception when calling PhonesApi->update_browser_registration: %s\n" % e)
294292
```
295293

296294
### Parameters
297295

298296
Name | Type | Description | Notes
299297
------------- | ------------- | ------------- | -------------
300298
**phone_id** | **str**| |
301-
**number** | **str**| | [optional]
302-
**name** | **str**| | [optional]
303-
**trunk_id** | **int**| | [optional]
304-
**pass_original_caller_id** | **str**| | [optional]
299+
**reg_status** | **str**| F - Phone is not registered (offline). N - Phone is registered (online). |
300+
**user_agent** | **str**| |
305301

306302
### Return type
307303

308-
[**PhoneDevice**](PhoneDevice.md)
304+
[**OkResponse**](OkResponse.md)
309305

310306
### Authorization
311307

@@ -318,10 +314,10 @@ Name | Type | Description | Notes
318314

319315
[[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)
320316

321-
# **update_phone_params**
322-
> OkResponse update_phone_params(phone_id, params)
317+
# **update_phone**
318+
> PhoneDevice update_phone(phone_id, number=number, name=name, trunk_id=trunk_id, pass_original_caller_id=pass_original_caller_id)
323319
324-
Update phone params
320+
Update phone
325321

326322
### Example
327323
```python
@@ -343,26 +339,32 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
343339
# create an instance of the API class
344340
api_instance = liveagent_api.PhonesApi(liveagent_api.ApiClient(configuration))
345341
phone_id = 'phone_id_example' # str |
346-
params = 'params_example' # str | New params
342+
number = 'number_example' # str | (optional)
343+
name = 'name_example' # str | (optional)
344+
trunk_id = 56 # int | (optional)
345+
pass_original_caller_id = 'pass_original_caller_id_example' # str | (optional)
347346

348347
try:
349-
# Update phone params
350-
api_response = api_instance.update_phone_params(phone_id, params)
348+
# Update phone
349+
api_response = api_instance.update_phone(phone_id, number=number, name=name, trunk_id=trunk_id, pass_original_caller_id=pass_original_caller_id)
351350
pprint(api_response)
352351
except ApiException as e:
353-
print("Exception when calling PhonesApi->update_phone_params: %s\n" % e)
352+
print("Exception when calling PhonesApi->update_phone: %s\n" % e)
354353
```
355354

356355
### Parameters
357356

358357
Name | Type | Description | Notes
359358
------------- | ------------- | ------------- | -------------
360359
**phone_id** | **str**| |
361-
**params** | **str**| New params |
360+
**number** | **str**| | [optional]
361+
**name** | **str**| | [optional]
362+
**trunk_id** | **int**| | [optional]
363+
**pass_original_caller_id** | **str**| | [optional]
362364

363365
### Return type
364366

365-
[**OkResponse**](OkResponse.md)
367+
[**PhoneDevice**](PhoneDevice.md)
366368

367369
### Authorization
368370

@@ -375,10 +377,10 @@ Name | Type | Description | Notes
375377

376378
[[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)
377379

378-
# **update_reg_status**
379-
> OkResponse update_reg_status(phone_id, reg_status)
380+
# **update_phone_params**
381+
> OkResponse update_phone_params(phone_id, params)
380382
381-
Update registration status
383+
Update phone params
382384

383385
### Example
384386
```python
@@ -400,22 +402,22 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
400402
# create an instance of the API class
401403
api_instance = liveagent_api.PhonesApi(liveagent_api.ApiClient(configuration))
402404
phone_id = 'phone_id_example' # str |
403-
reg_status = 'reg_status_example' # str | F - Phone is not registered (offline). N - Phone is registered (online).
405+
params = 'params_example' # str | New params
404406

405407
try:
406-
# Update registration status
407-
api_response = api_instance.update_reg_status(phone_id, reg_status)
408+
# Update phone params
409+
api_response = api_instance.update_phone_params(phone_id, params)
408410
pprint(api_response)
409411
except ApiException as e:
410-
print("Exception when calling PhonesApi->update_reg_status: %s\n" % e)
412+
print("Exception when calling PhonesApi->update_phone_params: %s\n" % e)
411413
```
412414

413415
### Parameters
414416

415417
Name | Type | Description | Notes
416418
------------- | ------------- | ------------- | -------------
417419
**phone_id** | **str**| |
418-
**reg_status** | **str**| F - Phone is not registered (offline). N - Phone is registered (online). |
420+
**params** | **str**| New params |
419421

420422
### Return type
421423

0 commit comments

Comments
 (0)