ultracart_api 3.10.191 → 3.10.193
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +19 -4
- data/docs/AutoOrder.md +1 -0
- data/docs/AutoOrderItem.md +2 -0
- data/docs/ConversationApi.md +408 -0
- data/docs/ConversationPbxVoicemailMessage.md +20 -0
- data/docs/ConversationPbxVoicemailMessageResponse.md +12 -0
- data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +12 -0
- data/docs/ConversationPbxVoicemailMessageSummary.md +17 -0
- data/docs/ItemApi.md +53 -0
- data/docs/WorkflowTask.md +2 -2
- data/docs/WorkflowTasksRequest.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +448 -0
- data/lib/ultracart_api/api/item_api.rb +60 -0
- data/lib/ultracart_api/models/auto_order.rb +11 -1
- data/lib/ultracart_api/models/auto_order_item.rb +21 -1
- data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +29 -5
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +339 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +223 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +309 -0
- data/lib/ultracart_api/models/workflow_task.rb +2 -2
- data/lib/ultracart_api/models/workflow_tasks_request.rb +21 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
@@ -0,0 +1,17 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**call_sid** | **String** | Call SID | [optional]
|
7
|
+
**duration** | **Integer** | Duration in seconds | [optional]
|
8
|
+
**from** | **String** | From phone number in E.164 | [optional]
|
9
|
+
**from_caller_id** | **String** | From caller id (if available) | [optional]
|
10
|
+
**listened** | **BOOLEAN** | True if the voicemail has been listened to in the user interface | [optional]
|
11
|
+
**merchant_id** | **String** | Merchant ID | [optional]
|
12
|
+
**recording_sid** | **String** | Recording SID | [optional]
|
13
|
+
**recording_size_bytes** | **Integer** | Recording size in bytes | [optional]
|
14
|
+
**recording_status** | **String** | Recording Status | [optional]
|
15
|
+
**voicemail_dts** | **String** | Voicemail date/time | [optional]
|
16
|
+
|
17
|
+
|
data/docs/ItemApi.md
CHANGED
@@ -20,6 +20,7 @@ Method | HTTP request | Description
|
|
20
20
|
[**insert_digital_item**](ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
|
21
21
|
[**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item
|
22
22
|
[**insert_review**](ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
|
23
|
+
[**insert_update_item_content_attribute**](ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute
|
23
24
|
[**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
|
24
25
|
[**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
|
25
26
|
[**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
|
@@ -889,6 +890,58 @@ Name | Type | Description | Notes
|
|
889
890
|
|
890
891
|
|
891
892
|
|
893
|
+
# **insert_update_item_content_attribute**
|
894
|
+
> insert_update_item_content_attribute(item_attribute, merchant_item_oid)
|
895
|
+
|
896
|
+
Upsert an item content attribute
|
897
|
+
|
898
|
+
Update an item content attribute, creating it new if it does not yet exist.
|
899
|
+
|
900
|
+
### Example
|
901
|
+
```ruby
|
902
|
+
# load the gem
|
903
|
+
require 'ultracart_api'
|
904
|
+
|
905
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
906
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
907
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
908
|
+
|
909
|
+
|
910
|
+
item_attribute = UltracartClient::ItemContentAttribute.new # ItemContentAttribute | Item content attribute to upsert
|
911
|
+
|
912
|
+
merchant_item_oid = 56 # Integer | The item oid to modify.
|
913
|
+
|
914
|
+
|
915
|
+
begin
|
916
|
+
#Upsert an item content attribute
|
917
|
+
api_instance.insert_update_item_content_attribute(item_attribute, merchant_item_oid)
|
918
|
+
rescue UltracartClient::ApiError => e
|
919
|
+
puts "Exception when calling ItemApi->insert_update_item_content_attribute: #{e}"
|
920
|
+
end
|
921
|
+
```
|
922
|
+
|
923
|
+
### Parameters
|
924
|
+
|
925
|
+
Name | Type | Description | Notes
|
926
|
+
------------- | ------------- | ------------- | -------------
|
927
|
+
**item_attribute** | [**ItemContentAttribute**](ItemContentAttribute.md)| Item content attribute to upsert |
|
928
|
+
**merchant_item_oid** | **Integer**| The item oid to modify. |
|
929
|
+
|
930
|
+
### Return type
|
931
|
+
|
932
|
+
nil (empty response body)
|
933
|
+
|
934
|
+
### Authorization
|
935
|
+
|
936
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
937
|
+
|
938
|
+
### HTTP request headers
|
939
|
+
|
940
|
+
- **Content-Type**: application/json; charset=UTF-8
|
941
|
+
- **Accept**: application/json
|
942
|
+
|
943
|
+
|
944
|
+
|
892
945
|
# **update_digital_item**
|
893
946
|
> ItemDigitalItemResponse update_digital_item(digital_item_oid, digital_item)
|
894
947
|
|
data/docs/WorkflowTask.md
CHANGED
@@ -15,14 +15,14 @@ Name | Type | Description | Notes
|
|
15
15
|
**dependant_workflow_task_uuid** | **String** | Dependant Workflow Task UUID (must be completed before this task can be completed) | [optional]
|
16
16
|
**due_dts** | **String** | Date/time that the workflow task is due | [optional]
|
17
17
|
**expiration_dts** | **String** | Date/time that the workflow task will expire and be closed. This is set by system generated tasks. | [optional]
|
18
|
-
**global_task_number** | **Integer** | Global task
|
18
|
+
**global_task_number** | **Integer** | Global task number | [optional]
|
19
19
|
**histories** | [**Array<WorkflowTaskHistory>**](WorkflowTaskHistory.md) | Array of history records for the task | [optional]
|
20
20
|
**last_update_dts** | **String** | Date/time that the workflow task was last updated | [optional]
|
21
21
|
**merchant_id** | **String** | Merchant ID | [optional]
|
22
22
|
**notes** | [**Array<WorkflowNote>**](WorkflowNote.md) | Notes on the Workflow Task | [optional]
|
23
23
|
**object_email** | **String** | Object is associated with customer email | [optional]
|
24
24
|
**object_id** | **String** | Object ID | [optional]
|
25
|
-
**object_task_number** | **Integer** | Object specific task
|
25
|
+
**object_task_number** | **Integer** | Object specific task number | [optional]
|
26
26
|
**object_type** | **String** | Object Type | [optional]
|
27
27
|
**object_url** | **String** | Object URL | [optional]
|
28
28
|
**priority** | **String** | Priority | [optional]
|
@@ -3,8 +3,10 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**assigned_to_group** | **String** | Assigned to group | [optional]
|
6
7
|
**assigned_to_group_id** | **Integer** | Assigned to group ID | [optional]
|
7
8
|
**assigned_to_me** | **BOOLEAN** | Tasks are assigned to me either by direct user id or a group that the user is a member of | [optional]
|
9
|
+
**assigned_to_user** | **String** | Assigned to user | [optional]
|
8
10
|
**assigned_to_user_id** | **Integer** | Assigned to user ID | [optional]
|
9
11
|
**created_by** | [**WorkflowUser**](WorkflowUser.md) | | [optional]
|
10
12
|
**created_dts_begin** | **String** | Date/time that the workflow task was created | [optional]
|
@@ -249,6 +249,60 @@ module UltracartClient
|
|
249
249
|
end
|
250
250
|
return data, status_code, headers
|
251
251
|
end
|
252
|
+
# Delete Agent Voicemail
|
253
|
+
# Delete pbx agent Voicemail
|
254
|
+
# @param recording_sid
|
255
|
+
# @param [Hash] opts the optional parameters
|
256
|
+
# @return [nil]
|
257
|
+
def delete_pbx_agent_voicemail(recording_sid, opts = {})
|
258
|
+
delete_pbx_agent_voicemail_with_http_info(recording_sid, opts)
|
259
|
+
nil
|
260
|
+
end
|
261
|
+
|
262
|
+
# Delete Agent Voicemail
|
263
|
+
# Delete pbx agent Voicemail
|
264
|
+
# @param recording_sid
|
265
|
+
# @param [Hash] opts the optional parameters
|
266
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
267
|
+
def delete_pbx_agent_voicemail_with_http_info(recording_sid, opts = {})
|
268
|
+
if @api_client.config.debugging
|
269
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_agent_voicemail ...'
|
270
|
+
end
|
271
|
+
# verify the required parameter 'recording_sid' is set
|
272
|
+
if @api_client.config.client_side_validation && recording_sid.nil?
|
273
|
+
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.delete_pbx_agent_voicemail"
|
274
|
+
end
|
275
|
+
# resource path
|
276
|
+
local_var_path = '/conversation/pbx/agent/voicemails/{recording_sid}'.sub('{' + 'recording_sid' + '}', recording_sid.to_s)
|
277
|
+
|
278
|
+
# query parameters
|
279
|
+
query_params = {}
|
280
|
+
|
281
|
+
# header parameters
|
282
|
+
header_params = {}
|
283
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
284
|
+
# HTTP header 'Accept' (if needed)
|
285
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
286
|
+
# HTTP header 'Content-Type'
|
287
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
288
|
+
|
289
|
+
# form parameters
|
290
|
+
form_params = {}
|
291
|
+
|
292
|
+
# http body (model)
|
293
|
+
post_body = nil
|
294
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
295
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
296
|
+
:header_params => header_params,
|
297
|
+
:query_params => query_params,
|
298
|
+
:form_params => form_params,
|
299
|
+
:body => post_body,
|
300
|
+
:auth_names => auth_names)
|
301
|
+
if @api_client.config.debugging
|
302
|
+
@api_client.config.logger.debug "API called: ConversationApi#delete_pbx_agent_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
303
|
+
end
|
304
|
+
return data, status_code, headers
|
305
|
+
end
|
252
306
|
# Delete pbx audio
|
253
307
|
# Delete a pbx audio
|
254
308
|
# @param conversation_pbx_audio_uuid
|
@@ -469,6 +523,66 @@ module UltracartClient
|
|
469
523
|
end
|
470
524
|
return data, status_code, headers
|
471
525
|
end
|
526
|
+
# Delete Queue Voicemail
|
527
|
+
# Delete pbx queue Voicemail
|
528
|
+
# @param queue_uuid
|
529
|
+
# @param recording_sid
|
530
|
+
# @param [Hash] opts the optional parameters
|
531
|
+
# @return [nil]
|
532
|
+
def delete_pbx_queue_voicemail(queue_uuid, recording_sid, opts = {})
|
533
|
+
delete_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts)
|
534
|
+
nil
|
535
|
+
end
|
536
|
+
|
537
|
+
# Delete Queue Voicemail
|
538
|
+
# Delete pbx queue Voicemail
|
539
|
+
# @param queue_uuid
|
540
|
+
# @param recording_sid
|
541
|
+
# @param [Hash] opts the optional parameters
|
542
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
543
|
+
def delete_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts = {})
|
544
|
+
if @api_client.config.debugging
|
545
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_queue_voicemail ...'
|
546
|
+
end
|
547
|
+
# verify the required parameter 'queue_uuid' is set
|
548
|
+
if @api_client.config.client_side_validation && queue_uuid.nil?
|
549
|
+
fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.delete_pbx_queue_voicemail"
|
550
|
+
end
|
551
|
+
# verify the required parameter 'recording_sid' is set
|
552
|
+
if @api_client.config.client_side_validation && recording_sid.nil?
|
553
|
+
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.delete_pbx_queue_voicemail"
|
554
|
+
end
|
555
|
+
# resource path
|
556
|
+
local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s).sub('{' + 'recording_sid' + '}', recording_sid.to_s)
|
557
|
+
|
558
|
+
# query parameters
|
559
|
+
query_params = {}
|
560
|
+
|
561
|
+
# header parameters
|
562
|
+
header_params = {}
|
563
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
564
|
+
# HTTP header 'Accept' (if needed)
|
565
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
566
|
+
# HTTP header 'Content-Type'
|
567
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
568
|
+
|
569
|
+
# form parameters
|
570
|
+
form_params = {}
|
571
|
+
|
572
|
+
# http body (model)
|
573
|
+
post_body = nil
|
574
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
575
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
576
|
+
:header_params => header_params,
|
577
|
+
:query_params => query_params,
|
578
|
+
:form_params => form_params,
|
579
|
+
:body => post_body,
|
580
|
+
:auth_names => auth_names)
|
581
|
+
if @api_client.config.debugging
|
582
|
+
@api_client.config.logger.debug "API called: ConversationApi#delete_pbx_queue_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
583
|
+
end
|
584
|
+
return data, status_code, headers
|
585
|
+
end
|
472
586
|
# Delete pbx timeBased
|
473
587
|
# Delete a pbx timeBased
|
474
588
|
# @param conversation_pbx_time_based_uuid
|
@@ -1746,6 +1860,110 @@ module UltracartClient
|
|
1746
1860
|
end
|
1747
1861
|
return data, status_code, headers
|
1748
1862
|
end
|
1863
|
+
# Get Agent Voicemail
|
1864
|
+
# Retrieve pbx agent Voicemail
|
1865
|
+
# @param recording_sid
|
1866
|
+
# @param [Hash] opts the optional parameters
|
1867
|
+
# @return [ConversationPbxVoicemailMessageResponse]
|
1868
|
+
def get_pbx_agent_voicemail(recording_sid, opts = {})
|
1869
|
+
data, _status_code, _headers = get_pbx_agent_voicemail_with_http_info(recording_sid, opts)
|
1870
|
+
data
|
1871
|
+
end
|
1872
|
+
|
1873
|
+
# Get Agent Voicemail
|
1874
|
+
# Retrieve pbx agent Voicemail
|
1875
|
+
# @param recording_sid
|
1876
|
+
# @param [Hash] opts the optional parameters
|
1877
|
+
# @return [Array<(ConversationPbxVoicemailMessageResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageResponse data, response status code and response headers
|
1878
|
+
def get_pbx_agent_voicemail_with_http_info(recording_sid, opts = {})
|
1879
|
+
if @api_client.config.debugging
|
1880
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agent_voicemail ...'
|
1881
|
+
end
|
1882
|
+
# verify the required parameter 'recording_sid' is set
|
1883
|
+
if @api_client.config.client_side_validation && recording_sid.nil?
|
1884
|
+
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.get_pbx_agent_voicemail"
|
1885
|
+
end
|
1886
|
+
# resource path
|
1887
|
+
local_var_path = '/conversation/pbx/agent/voicemails/{recording_sid}'.sub('{' + 'recording_sid' + '}', recording_sid.to_s)
|
1888
|
+
|
1889
|
+
# query parameters
|
1890
|
+
query_params = {}
|
1891
|
+
|
1892
|
+
# header parameters
|
1893
|
+
header_params = {}
|
1894
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1895
|
+
# HTTP header 'Accept' (if needed)
|
1896
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1897
|
+
# HTTP header 'Content-Type'
|
1898
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1899
|
+
|
1900
|
+
# form parameters
|
1901
|
+
form_params = {}
|
1902
|
+
|
1903
|
+
# http body (model)
|
1904
|
+
post_body = nil
|
1905
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1906
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1907
|
+
:header_params => header_params,
|
1908
|
+
:query_params => query_params,
|
1909
|
+
:form_params => form_params,
|
1910
|
+
:body => post_body,
|
1911
|
+
:auth_names => auth_names,
|
1912
|
+
:return_type => 'ConversationPbxVoicemailMessageResponse')
|
1913
|
+
if @api_client.config.debugging
|
1914
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_pbx_agent_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1915
|
+
end
|
1916
|
+
return data, status_code, headers
|
1917
|
+
end
|
1918
|
+
# Get Agent Voicemails
|
1919
|
+
# Retrieve pbx agent Voicemails
|
1920
|
+
# @param [Hash] opts the optional parameters
|
1921
|
+
# @return [ConversationPbxVoicemailMessageSummariesResponse]
|
1922
|
+
def get_pbx_agent_voicemails(opts = {})
|
1923
|
+
data, _status_code, _headers = get_pbx_agent_voicemails_with_http_info(opts)
|
1924
|
+
data
|
1925
|
+
end
|
1926
|
+
|
1927
|
+
# Get Agent Voicemails
|
1928
|
+
# Retrieve pbx agent Voicemails
|
1929
|
+
# @param [Hash] opts the optional parameters
|
1930
|
+
# @return [Array<(ConversationPbxVoicemailMessageSummariesResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageSummariesResponse data, response status code and response headers
|
1931
|
+
def get_pbx_agent_voicemails_with_http_info(opts = {})
|
1932
|
+
if @api_client.config.debugging
|
1933
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agent_voicemails ...'
|
1934
|
+
end
|
1935
|
+
# resource path
|
1936
|
+
local_var_path = '/conversation/pbx/agent/voicemails'
|
1937
|
+
|
1938
|
+
# query parameters
|
1939
|
+
query_params = {}
|
1940
|
+
|
1941
|
+
# header parameters
|
1942
|
+
header_params = {}
|
1943
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1944
|
+
# HTTP header 'Accept' (if needed)
|
1945
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1946
|
+
# HTTP header 'Content-Type'
|
1947
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1948
|
+
|
1949
|
+
# form parameters
|
1950
|
+
form_params = {}
|
1951
|
+
|
1952
|
+
# http body (model)
|
1953
|
+
post_body = nil
|
1954
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1955
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1956
|
+
:header_params => header_params,
|
1957
|
+
:query_params => query_params,
|
1958
|
+
:form_params => form_params,
|
1959
|
+
:body => post_body,
|
1960
|
+
:auth_names => auth_names,
|
1961
|
+
:return_type => 'ConversationPbxVoicemailMessageSummariesResponse')
|
1962
|
+
if @api_client.config.debugging
|
1963
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_pbx_agent_voicemails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1964
|
+
end
|
1965
|
+
return data, status_code, headers
|
1966
|
+
end
|
1749
1967
|
# Get pbx agents
|
1750
1968
|
# Retrieve pbx agents
|
1751
1969
|
# @param [Hash] opts the optional parameters
|
@@ -2162,6 +2380,122 @@ module UltracartClient
|
|
2162
2380
|
end
|
2163
2381
|
return data, status_code, headers
|
2164
2382
|
end
|
2383
|
+
# Get Queue Voicemail
|
2384
|
+
# Retrieve pbx queue Voicemail
|
2385
|
+
# @param queue_uuid
|
2386
|
+
# @param recording_sid
|
2387
|
+
# @param [Hash] opts the optional parameters
|
2388
|
+
# @return [ConversationPbxVoicemailMessageResponse]
|
2389
|
+
def get_pbx_queue_voicemail(queue_uuid, recording_sid, opts = {})
|
2390
|
+
data, _status_code, _headers = get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts)
|
2391
|
+
data
|
2392
|
+
end
|
2393
|
+
|
2394
|
+
# Get Queue Voicemail
|
2395
|
+
# Retrieve pbx queue Voicemail
|
2396
|
+
# @param queue_uuid
|
2397
|
+
# @param recording_sid
|
2398
|
+
# @param [Hash] opts the optional parameters
|
2399
|
+
# @return [Array<(ConversationPbxVoicemailMessageResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageResponse data, response status code and response headers
|
2400
|
+
def get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts = {})
|
2401
|
+
if @api_client.config.debugging
|
2402
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queue_voicemail ...'
|
2403
|
+
end
|
2404
|
+
# verify the required parameter 'queue_uuid' is set
|
2405
|
+
if @api_client.config.client_side_validation && queue_uuid.nil?
|
2406
|
+
fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.get_pbx_queue_voicemail"
|
2407
|
+
end
|
2408
|
+
# verify the required parameter 'recording_sid' is set
|
2409
|
+
if @api_client.config.client_side_validation && recording_sid.nil?
|
2410
|
+
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.get_pbx_queue_voicemail"
|
2411
|
+
end
|
2412
|
+
# resource path
|
2413
|
+
local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s).sub('{' + 'recording_sid' + '}', recording_sid.to_s)
|
2414
|
+
|
2415
|
+
# query parameters
|
2416
|
+
query_params = {}
|
2417
|
+
|
2418
|
+
# header parameters
|
2419
|
+
header_params = {}
|
2420
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2421
|
+
# HTTP header 'Accept' (if needed)
|
2422
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2423
|
+
# HTTP header 'Content-Type'
|
2424
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2425
|
+
|
2426
|
+
# form parameters
|
2427
|
+
form_params = {}
|
2428
|
+
|
2429
|
+
# http body (model)
|
2430
|
+
post_body = nil
|
2431
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
2432
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2433
|
+
:header_params => header_params,
|
2434
|
+
:query_params => query_params,
|
2435
|
+
:form_params => form_params,
|
2436
|
+
:body => post_body,
|
2437
|
+
:auth_names => auth_names,
|
2438
|
+
:return_type => 'ConversationPbxVoicemailMessageResponse')
|
2439
|
+
if @api_client.config.debugging
|
2440
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_pbx_queue_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2441
|
+
end
|
2442
|
+
return data, status_code, headers
|
2443
|
+
end
|
2444
|
+
# Get Queue Voicemails
|
2445
|
+
# Retrieve pbx queue voicemails
|
2446
|
+
# @param queue_uuid
|
2447
|
+
# @param [Hash] opts the optional parameters
|
2448
|
+
# @return [ConversationPbxVoicemailMessageSummariesResponse]
|
2449
|
+
def get_pbx_queue_voicemails(queue_uuid, opts = {})
|
2450
|
+
data, _status_code, _headers = get_pbx_queue_voicemails_with_http_info(queue_uuid, opts)
|
2451
|
+
data
|
2452
|
+
end
|
2453
|
+
|
2454
|
+
# Get Queue Voicemails
|
2455
|
+
# Retrieve pbx queue voicemails
|
2456
|
+
# @param queue_uuid
|
2457
|
+
# @param [Hash] opts the optional parameters
|
2458
|
+
# @return [Array<(ConversationPbxVoicemailMessageSummariesResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageSummariesResponse data, response status code and response headers
|
2459
|
+
def get_pbx_queue_voicemails_with_http_info(queue_uuid, opts = {})
|
2460
|
+
if @api_client.config.debugging
|
2461
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queue_voicemails ...'
|
2462
|
+
end
|
2463
|
+
# verify the required parameter 'queue_uuid' is set
|
2464
|
+
if @api_client.config.client_side_validation && queue_uuid.nil?
|
2465
|
+
fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.get_pbx_queue_voicemails"
|
2466
|
+
end
|
2467
|
+
# resource path
|
2468
|
+
local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s)
|
2469
|
+
|
2470
|
+
# query parameters
|
2471
|
+
query_params = {}
|
2472
|
+
|
2473
|
+
# header parameters
|
2474
|
+
header_params = {}
|
2475
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2476
|
+
# HTTP header 'Accept' (if needed)
|
2477
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2478
|
+
# HTTP header 'Content-Type'
|
2479
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2480
|
+
|
2481
|
+
# form parameters
|
2482
|
+
form_params = {}
|
2483
|
+
|
2484
|
+
# http body (model)
|
2485
|
+
post_body = nil
|
2486
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
2487
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2488
|
+
:header_params => header_params,
|
2489
|
+
:query_params => query_params,
|
2490
|
+
:form_params => form_params,
|
2491
|
+
:body => post_body,
|
2492
|
+
:auth_names => auth_names,
|
2493
|
+
:return_type => 'ConversationPbxVoicemailMessageSummariesResponse')
|
2494
|
+
if @api_client.config.debugging
|
2495
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_pbx_queue_voicemails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2496
|
+
end
|
2497
|
+
return data, status_code, headers
|
2498
|
+
end
|
2165
2499
|
# Get pbx queues
|
2166
2500
|
# Retrieve pbx queues
|
2167
2501
|
# @param [Hash] opts the optional parameters
|
@@ -3238,6 +3572,120 @@ module UltracartClient
|
|
3238
3572
|
end
|
3239
3573
|
return data, status_code, headers
|
3240
3574
|
end
|
3575
|
+
# Listened Agent Voicemail
|
3576
|
+
# Listened pbx agent Voicemail
|
3577
|
+
# @param recording_sid
|
3578
|
+
# @param [Hash] opts the optional parameters
|
3579
|
+
# @return [nil]
|
3580
|
+
def listened_pbx_agent_voicemail(recording_sid, opts = {})
|
3581
|
+
listened_pbx_agent_voicemail_with_http_info(recording_sid, opts)
|
3582
|
+
nil
|
3583
|
+
end
|
3584
|
+
|
3585
|
+
# Listened Agent Voicemail
|
3586
|
+
# Listened pbx agent Voicemail
|
3587
|
+
# @param recording_sid
|
3588
|
+
# @param [Hash] opts the optional parameters
|
3589
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
3590
|
+
def listened_pbx_agent_voicemail_with_http_info(recording_sid, opts = {})
|
3591
|
+
if @api_client.config.debugging
|
3592
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.listened_pbx_agent_voicemail ...'
|
3593
|
+
end
|
3594
|
+
# verify the required parameter 'recording_sid' is set
|
3595
|
+
if @api_client.config.client_side_validation && recording_sid.nil?
|
3596
|
+
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.listened_pbx_agent_voicemail"
|
3597
|
+
end
|
3598
|
+
# resource path
|
3599
|
+
local_var_path = '/conversation/pbx/agent/voicemails/{recording_sid}/listened'.sub('{' + 'recording_sid' + '}', recording_sid.to_s)
|
3600
|
+
|
3601
|
+
# query parameters
|
3602
|
+
query_params = {}
|
3603
|
+
|
3604
|
+
# header parameters
|
3605
|
+
header_params = {}
|
3606
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
3607
|
+
# HTTP header 'Accept' (if needed)
|
3608
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3609
|
+
# HTTP header 'Content-Type'
|
3610
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3611
|
+
|
3612
|
+
# form parameters
|
3613
|
+
form_params = {}
|
3614
|
+
|
3615
|
+
# http body (model)
|
3616
|
+
post_body = nil
|
3617
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
3618
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
3619
|
+
:header_params => header_params,
|
3620
|
+
:query_params => query_params,
|
3621
|
+
:form_params => form_params,
|
3622
|
+
:body => post_body,
|
3623
|
+
:auth_names => auth_names)
|
3624
|
+
if @api_client.config.debugging
|
3625
|
+
@api_client.config.logger.debug "API called: ConversationApi#listened_pbx_agent_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3626
|
+
end
|
3627
|
+
return data, status_code, headers
|
3628
|
+
end
|
3629
|
+
# Listened Queue Voicemail
|
3630
|
+
# Listened pbx queue Voicemail
|
3631
|
+
# @param queue_uuid
|
3632
|
+
# @param recording_sid
|
3633
|
+
# @param [Hash] opts the optional parameters
|
3634
|
+
# @return [nil]
|
3635
|
+
def listened_pbx_queue_voicemail(queue_uuid, recording_sid, opts = {})
|
3636
|
+
listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts)
|
3637
|
+
nil
|
3638
|
+
end
|
3639
|
+
|
3640
|
+
# Listened Queue Voicemail
|
3641
|
+
# Listened pbx queue Voicemail
|
3642
|
+
# @param queue_uuid
|
3643
|
+
# @param recording_sid
|
3644
|
+
# @param [Hash] opts the optional parameters
|
3645
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
3646
|
+
def listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts = {})
|
3647
|
+
if @api_client.config.debugging
|
3648
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.listened_pbx_queue_voicemail ...'
|
3649
|
+
end
|
3650
|
+
# verify the required parameter 'queue_uuid' is set
|
3651
|
+
if @api_client.config.client_side_validation && queue_uuid.nil?
|
3652
|
+
fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.listened_pbx_queue_voicemail"
|
3653
|
+
end
|
3654
|
+
# verify the required parameter 'recording_sid' is set
|
3655
|
+
if @api_client.config.client_side_validation && recording_sid.nil?
|
3656
|
+
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.listened_pbx_queue_voicemail"
|
3657
|
+
end
|
3658
|
+
# resource path
|
3659
|
+
local_var_path = '/conversation/pbx/{queue_uuid}/voicemails/voicemails/{recording_sid}/listened'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s).sub('{' + 'recording_sid' + '}', recording_sid.to_s)
|
3660
|
+
|
3661
|
+
# query parameters
|
3662
|
+
query_params = {}
|
3663
|
+
|
3664
|
+
# header parameters
|
3665
|
+
header_params = {}
|
3666
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
3667
|
+
# HTTP header 'Accept' (if needed)
|
3668
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3669
|
+
# HTTP header 'Content-Type'
|
3670
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3671
|
+
|
3672
|
+
# form parameters
|
3673
|
+
form_params = {}
|
3674
|
+
|
3675
|
+
# http body (model)
|
3676
|
+
post_body = nil
|
3677
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
3678
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
3679
|
+
:header_params => header_params,
|
3680
|
+
:query_params => query_params,
|
3681
|
+
:form_params => form_params,
|
3682
|
+
:body => post_body,
|
3683
|
+
:auth_names => auth_names)
|
3684
|
+
if @api_client.config.debugging
|
3685
|
+
@api_client.config.logger.debug "API called: ConversationApi#listened_pbx_queue_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3686
|
+
end
|
3687
|
+
return data, status_code, headers
|
3688
|
+
end
|
3241
3689
|
# Mark a conversation as read
|
3242
3690
|
# Mark a conversation as read
|
3243
3691
|
# @param conversation_uuid
|
@@ -984,6 +984,66 @@ module UltracartClient
|
|
984
984
|
end
|
985
985
|
return data, status_code, headers
|
986
986
|
end
|
987
|
+
# Upsert an item content attribute
|
988
|
+
# Update an item content attribute, creating it new if it does not yet exist.
|
989
|
+
# @param item_attribute Item content attribute to upsert
|
990
|
+
# @param merchant_item_oid The item oid to modify.
|
991
|
+
# @param [Hash] opts the optional parameters
|
992
|
+
# @return [nil]
|
993
|
+
def insert_update_item_content_attribute(item_attribute, merchant_item_oid, opts = {})
|
994
|
+
insert_update_item_content_attribute_with_http_info(item_attribute, merchant_item_oid, opts)
|
995
|
+
nil
|
996
|
+
end
|
997
|
+
|
998
|
+
# Upsert an item content attribute
|
999
|
+
# Update an item content attribute, creating it new if it does not yet exist.
|
1000
|
+
# @param item_attribute Item content attribute to upsert
|
1001
|
+
# @param merchant_item_oid The item oid to modify.
|
1002
|
+
# @param [Hash] opts the optional parameters
|
1003
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1004
|
+
def insert_update_item_content_attribute_with_http_info(item_attribute, merchant_item_oid, opts = {})
|
1005
|
+
if @api_client.config.debugging
|
1006
|
+
@api_client.config.logger.debug 'Calling API: ItemApi.insert_update_item_content_attribute ...'
|
1007
|
+
end
|
1008
|
+
# verify the required parameter 'item_attribute' is set
|
1009
|
+
if @api_client.config.client_side_validation && item_attribute.nil?
|
1010
|
+
fail ArgumentError, "Missing the required parameter 'item_attribute' when calling ItemApi.insert_update_item_content_attribute"
|
1011
|
+
end
|
1012
|
+
# verify the required parameter 'merchant_item_oid' is set
|
1013
|
+
if @api_client.config.client_side_validation && merchant_item_oid.nil?
|
1014
|
+
fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.insert_update_item_content_attribute"
|
1015
|
+
end
|
1016
|
+
# resource path
|
1017
|
+
local_var_path = '/item/items/{merchant_item_oid}/content/attributes'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)
|
1018
|
+
|
1019
|
+
# query parameters
|
1020
|
+
query_params = {}
|
1021
|
+
|
1022
|
+
# header parameters
|
1023
|
+
header_params = {}
|
1024
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1025
|
+
# HTTP header 'Accept' (if needed)
|
1026
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1027
|
+
# HTTP header 'Content-Type'
|
1028
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
1029
|
+
|
1030
|
+
# form parameters
|
1031
|
+
form_params = {}
|
1032
|
+
|
1033
|
+
# http body (model)
|
1034
|
+
post_body = @api_client.object_to_http_body(item_attribute)
|
1035
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1036
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1037
|
+
:header_params => header_params,
|
1038
|
+
:query_params => query_params,
|
1039
|
+
:form_params => form_params,
|
1040
|
+
:body => post_body,
|
1041
|
+
:auth_names => auth_names)
|
1042
|
+
if @api_client.config.debugging
|
1043
|
+
@api_client.config.logger.debug "API called: ItemApi#insert_update_item_content_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1044
|
+
end
|
1045
|
+
return data, status_code, headers
|
1046
|
+
end
|
987
1047
|
# Updates a file within the digital library
|
988
1048
|
# Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
|
989
1049
|
# @param digital_item_oid The digital item oid to update.
|