ultracart_api 4.0.207 → 4.0.209
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +16 -4
- data/docs/AutoOrder.md +2 -0
- data/docs/AutoOrderItem.md +2 -0
- data/docs/ConversationApi.md +429 -0
- data/docs/ConversationPbxVoicemailMessage.md +42 -0
- data/docs/ConversationPbxVoicemailMessageResponse.md +26 -0
- data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +26 -0
- data/docs/ConversationPbxVoicemailMessageSummary.md +36 -0
- data/docs/WorkflowTask.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +384 -0
- data/lib/ultracart_api/models/auto_order.rb +11 -1
- data/lib/ultracart_api/models/auto_order_item.rb +11 -1
- data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +29 -5
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +374 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +344 -0
- data/lib/ultracart_api/models/workflow_task.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
10
|
+
| **voicemail_message** | [**ConversationPbxVoicemailMessage**](ConversationPbxVoicemailMessage.md) | | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationPbxVoicemailMessageResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
voicemail_message: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageSummariesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
10
|
+
| **voicemail_message_summaries** | [**Array<ConversationPbxVoicemailMessageSummary>**](ConversationPbxVoicemailMessageSummary.md) | | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationPbxVoicemailMessageSummariesResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
voicemail_message_summaries: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **call_sid** | **String** | Call SID | [optional] |
|
8
|
+
| **duration** | **Integer** | Duration in seconds | [optional] |
|
9
|
+
| **from** | **String** | From phone number in E.164 | [optional] |
|
10
|
+
| **from_caller_id** | **String** | From caller id (if available) | [optional] |
|
11
|
+
| **listened** | **Boolean** | True if the voicemail has been listened to in the user interface | [optional] |
|
12
|
+
| **merchant_id** | **String** | Merchant ID | [optional] |
|
13
|
+
| **recording_sid** | **String** | Recording SID | [optional] |
|
14
|
+
| **recording_size_bytes** | **Integer** | Recording size in bytes | [optional] |
|
15
|
+
| **recording_status** | **String** | Recording Status | [optional] |
|
16
|
+
| **voicemail_dts** | **String** | Voicemail date/time | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'ultracart_api'
|
22
|
+
|
23
|
+
instance = UltracartClient::ConversationPbxVoicemailMessageSummary.new(
|
24
|
+
call_sid: null,
|
25
|
+
duration: null,
|
26
|
+
from: null,
|
27
|
+
from_caller_id: null,
|
28
|
+
listened: null,
|
29
|
+
merchant_id: null,
|
30
|
+
recording_sid: null,
|
31
|
+
recording_size_bytes: null,
|
32
|
+
recording_status: null,
|
33
|
+
voicemail_dts: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
data/docs/WorkflowTask.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
| **assigned_to_group_id** | **Integer** | Assigned to group ID | [optional] |
|
9
9
|
| **assigned_to_user** | **String** | Assigned to user | [optional] |
|
10
10
|
| **assigned_to_user_id** | **Integer** | Assigned to user ID | [optional] |
|
11
|
+
| **assigned_to_user_or_group** | **String** | Assigned to user or group (used for sorting) | [optional] |
|
11
12
|
| **attachments** | [**Array<WorkflowAttachment>**](WorkflowAttachment.md) | Attachments to the Workflow Task | [optional] |
|
12
13
|
| **created_by** | [**WorkflowUser**](WorkflowUser.md) | | [optional] |
|
13
14
|
| **created_dts** | **String** | Date/time that the workflow task was created | [optional] |
|
@@ -46,6 +47,7 @@ instance = UltracartClient::WorkflowTask.new(
|
|
46
47
|
assigned_to_group_id: null,
|
47
48
|
assigned_to_user: null,
|
48
49
|
assigned_to_user_id: null,
|
50
|
+
assigned_to_user_or_group: null,
|
49
51
|
attachments: null,
|
50
52
|
created_by: null,
|
51
53
|
created_dts: null,
|
@@ -288,6 +288,70 @@ module UltracartClient
|
|
288
288
|
return data, status_code, headers
|
289
289
|
end
|
290
290
|
|
291
|
+
# Delete Agent Voicemail
|
292
|
+
# Delete pbx agent Voicemail
|
293
|
+
# @param recording_sid [String]
|
294
|
+
# @param [Hash] opts the optional parameters
|
295
|
+
# @return [nil]
|
296
|
+
def delete_pbx_agent_voicemail(recording_sid, opts = {})
|
297
|
+
delete_pbx_agent_voicemail_with_http_info(recording_sid, opts)
|
298
|
+
nil
|
299
|
+
end
|
300
|
+
|
301
|
+
# Delete Agent Voicemail
|
302
|
+
# Delete pbx agent Voicemail
|
303
|
+
# @param recording_sid [String]
|
304
|
+
# @param [Hash] opts the optional parameters
|
305
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
306
|
+
def delete_pbx_agent_voicemail_with_http_info(recording_sid, opts = {})
|
307
|
+
if @api_client.config.debugging
|
308
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_agent_voicemail ...'
|
309
|
+
end
|
310
|
+
# verify the required parameter 'recording_sid' is set
|
311
|
+
if @api_client.config.client_side_validation && recording_sid.nil?
|
312
|
+
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.delete_pbx_agent_voicemail"
|
313
|
+
end
|
314
|
+
# resource path
|
315
|
+
local_var_path = '/conversation/pbx/agent/voicemails/{recording_sid}'.sub('{' + 'recording_sid' + '}', CGI.escape(recording_sid.to_s))
|
316
|
+
|
317
|
+
# query parameters
|
318
|
+
query_params = opts[:query_params] || {}
|
319
|
+
|
320
|
+
# header parameters
|
321
|
+
header_params = opts[:header_params] || {}
|
322
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
323
|
+
# HTTP header 'Accept' (if needed)
|
324
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
325
|
+
|
326
|
+
# form parameters
|
327
|
+
form_params = opts[:form_params] || {}
|
328
|
+
|
329
|
+
# http body (model)
|
330
|
+
post_body = opts[:debug_body]
|
331
|
+
|
332
|
+
# return_type
|
333
|
+
return_type = opts[:debug_return_type]
|
334
|
+
|
335
|
+
# auth_names
|
336
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
337
|
+
|
338
|
+
new_options = opts.merge(
|
339
|
+
:operation => :"ConversationApi.delete_pbx_agent_voicemail",
|
340
|
+
:header_params => header_params,
|
341
|
+
:query_params => query_params,
|
342
|
+
:form_params => form_params,
|
343
|
+
:body => post_body,
|
344
|
+
:auth_names => auth_names,
|
345
|
+
:return_type => return_type
|
346
|
+
)
|
347
|
+
|
348
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
349
|
+
if @api_client.config.debugging
|
350
|
+
@api_client.config.logger.debug "API called: ConversationApi#delete_pbx_agent_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
351
|
+
end
|
352
|
+
return data, status_code, headers
|
353
|
+
end
|
354
|
+
|
291
355
|
# Delete pbx audio
|
292
356
|
# Delete a pbx audio
|
293
357
|
# @param conversation_pbx_audio_uuid [String]
|
@@ -2053,6 +2117,128 @@ module UltracartClient
|
|
2053
2117
|
return data, status_code, headers
|
2054
2118
|
end
|
2055
2119
|
|
2120
|
+
# Get Agent Voicemail
|
2121
|
+
# Retrieve pbx agent Voicemail
|
2122
|
+
# @param recording_sid [String]
|
2123
|
+
# @param [Hash] opts the optional parameters
|
2124
|
+
# @return [ConversationPbxVoicemailMessageResponse]
|
2125
|
+
def get_pbx_agent_voicemail(recording_sid, opts = {})
|
2126
|
+
data, _status_code, _headers = get_pbx_agent_voicemail_with_http_info(recording_sid, opts)
|
2127
|
+
data
|
2128
|
+
end
|
2129
|
+
|
2130
|
+
# Get Agent Voicemail
|
2131
|
+
# Retrieve pbx agent Voicemail
|
2132
|
+
# @param recording_sid [String]
|
2133
|
+
# @param [Hash] opts the optional parameters
|
2134
|
+
# @return [Array<(ConversationPbxVoicemailMessageResponse, Integer, Hash)>] ConversationPbxVoicemailMessageResponse data, response status code and response headers
|
2135
|
+
def get_pbx_agent_voicemail_with_http_info(recording_sid, opts = {})
|
2136
|
+
if @api_client.config.debugging
|
2137
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agent_voicemail ...'
|
2138
|
+
end
|
2139
|
+
# verify the required parameter 'recording_sid' is set
|
2140
|
+
if @api_client.config.client_side_validation && recording_sid.nil?
|
2141
|
+
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.get_pbx_agent_voicemail"
|
2142
|
+
end
|
2143
|
+
# resource path
|
2144
|
+
local_var_path = '/conversation/pbx/agent/voicemails/{recording_sid}'.sub('{' + 'recording_sid' + '}', CGI.escape(recording_sid.to_s))
|
2145
|
+
|
2146
|
+
# query parameters
|
2147
|
+
query_params = opts[:query_params] || {}
|
2148
|
+
|
2149
|
+
# header parameters
|
2150
|
+
header_params = opts[:header_params] || {}
|
2151
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2152
|
+
# HTTP header 'Accept' (if needed)
|
2153
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2154
|
+
|
2155
|
+
# form parameters
|
2156
|
+
form_params = opts[:form_params] || {}
|
2157
|
+
|
2158
|
+
# http body (model)
|
2159
|
+
post_body = opts[:debug_body]
|
2160
|
+
|
2161
|
+
# return_type
|
2162
|
+
return_type = opts[:debug_return_type] || 'ConversationPbxVoicemailMessageResponse'
|
2163
|
+
|
2164
|
+
# auth_names
|
2165
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
2166
|
+
|
2167
|
+
new_options = opts.merge(
|
2168
|
+
:operation => :"ConversationApi.get_pbx_agent_voicemail",
|
2169
|
+
:header_params => header_params,
|
2170
|
+
:query_params => query_params,
|
2171
|
+
:form_params => form_params,
|
2172
|
+
:body => post_body,
|
2173
|
+
:auth_names => auth_names,
|
2174
|
+
:return_type => return_type
|
2175
|
+
)
|
2176
|
+
|
2177
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2178
|
+
if @api_client.config.debugging
|
2179
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_pbx_agent_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2180
|
+
end
|
2181
|
+
return data, status_code, headers
|
2182
|
+
end
|
2183
|
+
|
2184
|
+
# Get Agent Voicemails
|
2185
|
+
# Retrieve pbx agent Voicemails
|
2186
|
+
# @param [Hash] opts the optional parameters
|
2187
|
+
# @return [ConversationPbxVoicemailMessageSummariesResponse]
|
2188
|
+
def get_pbx_agent_voicemails(opts = {})
|
2189
|
+
data, _status_code, _headers = get_pbx_agent_voicemails_with_http_info(opts)
|
2190
|
+
data
|
2191
|
+
end
|
2192
|
+
|
2193
|
+
# Get Agent Voicemails
|
2194
|
+
# Retrieve pbx agent Voicemails
|
2195
|
+
# @param [Hash] opts the optional parameters
|
2196
|
+
# @return [Array<(ConversationPbxVoicemailMessageSummariesResponse, Integer, Hash)>] ConversationPbxVoicemailMessageSummariesResponse data, response status code and response headers
|
2197
|
+
def get_pbx_agent_voicemails_with_http_info(opts = {})
|
2198
|
+
if @api_client.config.debugging
|
2199
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agent_voicemails ...'
|
2200
|
+
end
|
2201
|
+
# resource path
|
2202
|
+
local_var_path = '/conversation/pbx/agent/voicemails'
|
2203
|
+
|
2204
|
+
# query parameters
|
2205
|
+
query_params = opts[:query_params] || {}
|
2206
|
+
|
2207
|
+
# header parameters
|
2208
|
+
header_params = opts[:header_params] || {}
|
2209
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2210
|
+
# HTTP header 'Accept' (if needed)
|
2211
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2212
|
+
|
2213
|
+
# form parameters
|
2214
|
+
form_params = opts[:form_params] || {}
|
2215
|
+
|
2216
|
+
# http body (model)
|
2217
|
+
post_body = opts[:debug_body]
|
2218
|
+
|
2219
|
+
# return_type
|
2220
|
+
return_type = opts[:debug_return_type] || 'ConversationPbxVoicemailMessageSummariesResponse'
|
2221
|
+
|
2222
|
+
# auth_names
|
2223
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
2224
|
+
|
2225
|
+
new_options = opts.merge(
|
2226
|
+
:operation => :"ConversationApi.get_pbx_agent_voicemails",
|
2227
|
+
:header_params => header_params,
|
2228
|
+
:query_params => query_params,
|
2229
|
+
:form_params => form_params,
|
2230
|
+
:body => post_body,
|
2231
|
+
:auth_names => auth_names,
|
2232
|
+
:return_type => return_type
|
2233
|
+
)
|
2234
|
+
|
2235
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2236
|
+
if @api_client.config.debugging
|
2237
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_pbx_agent_voicemails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2238
|
+
end
|
2239
|
+
return data, status_code, headers
|
2240
|
+
end
|
2241
|
+
|
2056
2242
|
# Get pbx agents
|
2057
2243
|
# Retrieve pbx agents
|
2058
2244
|
# @param [Hash] opts the optional parameters
|
@@ -2541,6 +2727,140 @@ module UltracartClient
|
|
2541
2727
|
return data, status_code, headers
|
2542
2728
|
end
|
2543
2729
|
|
2730
|
+
# Get Queue Voicemail
|
2731
|
+
# Retrieve pbx queue Voicemail
|
2732
|
+
# @param queue_uuid [String]
|
2733
|
+
# @param recording_sid [String]
|
2734
|
+
# @param [Hash] opts the optional parameters
|
2735
|
+
# @return [ConversationPbxVoicemailMessageResponse]
|
2736
|
+
def get_pbx_queue_voicemail(queue_uuid, recording_sid, opts = {})
|
2737
|
+
data, _status_code, _headers = get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts)
|
2738
|
+
data
|
2739
|
+
end
|
2740
|
+
|
2741
|
+
# Get Queue Voicemail
|
2742
|
+
# Retrieve pbx queue Voicemail
|
2743
|
+
# @param queue_uuid [String]
|
2744
|
+
# @param recording_sid [String]
|
2745
|
+
# @param [Hash] opts the optional parameters
|
2746
|
+
# @return [Array<(ConversationPbxVoicemailMessageResponse, Integer, Hash)>] ConversationPbxVoicemailMessageResponse data, response status code and response headers
|
2747
|
+
def get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts = {})
|
2748
|
+
if @api_client.config.debugging
|
2749
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queue_voicemail ...'
|
2750
|
+
end
|
2751
|
+
# verify the required parameter 'queue_uuid' is set
|
2752
|
+
if @api_client.config.client_side_validation && queue_uuid.nil?
|
2753
|
+
fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.get_pbx_queue_voicemail"
|
2754
|
+
end
|
2755
|
+
# verify the required parameter 'recording_sid' is set
|
2756
|
+
if @api_client.config.client_side_validation && recording_sid.nil?
|
2757
|
+
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.get_pbx_queue_voicemail"
|
2758
|
+
end
|
2759
|
+
# resource path
|
2760
|
+
local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}'.sub('{' + 'queue_uuid' + '}', CGI.escape(queue_uuid.to_s)).sub('{' + 'recording_sid' + '}', CGI.escape(recording_sid.to_s))
|
2761
|
+
|
2762
|
+
# query parameters
|
2763
|
+
query_params = opts[:query_params] || {}
|
2764
|
+
|
2765
|
+
# header parameters
|
2766
|
+
header_params = opts[:header_params] || {}
|
2767
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2768
|
+
# HTTP header 'Accept' (if needed)
|
2769
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2770
|
+
|
2771
|
+
# form parameters
|
2772
|
+
form_params = opts[:form_params] || {}
|
2773
|
+
|
2774
|
+
# http body (model)
|
2775
|
+
post_body = opts[:debug_body]
|
2776
|
+
|
2777
|
+
# return_type
|
2778
|
+
return_type = opts[:debug_return_type] || 'ConversationPbxVoicemailMessageResponse'
|
2779
|
+
|
2780
|
+
# auth_names
|
2781
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
2782
|
+
|
2783
|
+
new_options = opts.merge(
|
2784
|
+
:operation => :"ConversationApi.get_pbx_queue_voicemail",
|
2785
|
+
:header_params => header_params,
|
2786
|
+
:query_params => query_params,
|
2787
|
+
:form_params => form_params,
|
2788
|
+
:body => post_body,
|
2789
|
+
:auth_names => auth_names,
|
2790
|
+
:return_type => return_type
|
2791
|
+
)
|
2792
|
+
|
2793
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2794
|
+
if @api_client.config.debugging
|
2795
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_pbx_queue_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2796
|
+
end
|
2797
|
+
return data, status_code, headers
|
2798
|
+
end
|
2799
|
+
|
2800
|
+
# Get Queue Voicemails
|
2801
|
+
# Retrieve pbx queue voicemails
|
2802
|
+
# @param queue_uuid [String]
|
2803
|
+
# @param [Hash] opts the optional parameters
|
2804
|
+
# @return [ConversationPbxVoicemailMessageSummariesResponse]
|
2805
|
+
def get_pbx_queue_voicemails(queue_uuid, opts = {})
|
2806
|
+
data, _status_code, _headers = get_pbx_queue_voicemails_with_http_info(queue_uuid, opts)
|
2807
|
+
data
|
2808
|
+
end
|
2809
|
+
|
2810
|
+
# Get Queue Voicemails
|
2811
|
+
# Retrieve pbx queue voicemails
|
2812
|
+
# @param queue_uuid [String]
|
2813
|
+
# @param [Hash] opts the optional parameters
|
2814
|
+
# @return [Array<(ConversationPbxVoicemailMessageSummariesResponse, Integer, Hash)>] ConversationPbxVoicemailMessageSummariesResponse data, response status code and response headers
|
2815
|
+
def get_pbx_queue_voicemails_with_http_info(queue_uuid, opts = {})
|
2816
|
+
if @api_client.config.debugging
|
2817
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queue_voicemails ...'
|
2818
|
+
end
|
2819
|
+
# verify the required parameter 'queue_uuid' is set
|
2820
|
+
if @api_client.config.client_side_validation && queue_uuid.nil?
|
2821
|
+
fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.get_pbx_queue_voicemails"
|
2822
|
+
end
|
2823
|
+
# resource path
|
2824
|
+
local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails'.sub('{' + 'queue_uuid' + '}', CGI.escape(queue_uuid.to_s))
|
2825
|
+
|
2826
|
+
# query parameters
|
2827
|
+
query_params = opts[:query_params] || {}
|
2828
|
+
|
2829
|
+
# header parameters
|
2830
|
+
header_params = opts[:header_params] || {}
|
2831
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2832
|
+
# HTTP header 'Accept' (if needed)
|
2833
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2834
|
+
|
2835
|
+
# form parameters
|
2836
|
+
form_params = opts[:form_params] || {}
|
2837
|
+
|
2838
|
+
# http body (model)
|
2839
|
+
post_body = opts[:debug_body]
|
2840
|
+
|
2841
|
+
# return_type
|
2842
|
+
return_type = opts[:debug_return_type] || 'ConversationPbxVoicemailMessageSummariesResponse'
|
2843
|
+
|
2844
|
+
# auth_names
|
2845
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
2846
|
+
|
2847
|
+
new_options = opts.merge(
|
2848
|
+
:operation => :"ConversationApi.get_pbx_queue_voicemails",
|
2849
|
+
:header_params => header_params,
|
2850
|
+
:query_params => query_params,
|
2851
|
+
:form_params => form_params,
|
2852
|
+
:body => post_body,
|
2853
|
+
:auth_names => auth_names,
|
2854
|
+
:return_type => return_type
|
2855
|
+
)
|
2856
|
+
|
2857
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2858
|
+
if @api_client.config.debugging
|
2859
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_pbx_queue_voicemails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2860
|
+
end
|
2861
|
+
return data, status_code, headers
|
2862
|
+
end
|
2863
|
+
|
2544
2864
|
# Get pbx queues
|
2545
2865
|
# Retrieve pbx queues
|
2546
2866
|
# @param [Hash] opts the optional parameters
|
@@ -3859,6 +4179,70 @@ module UltracartClient
|
|
3859
4179
|
return data, status_code, headers
|
3860
4180
|
end
|
3861
4181
|
|
4182
|
+
# Listened Agent Voicemail
|
4183
|
+
# Listened pbx agent Voicemail
|
4184
|
+
# @param recording_sid [String]
|
4185
|
+
# @param [Hash] opts the optional parameters
|
4186
|
+
# @return [nil]
|
4187
|
+
def listened_pbx_agent_voicemail(recording_sid, opts = {})
|
4188
|
+
listened_pbx_agent_voicemail_with_http_info(recording_sid, opts)
|
4189
|
+
nil
|
4190
|
+
end
|
4191
|
+
|
4192
|
+
# Listened Agent Voicemail
|
4193
|
+
# Listened pbx agent Voicemail
|
4194
|
+
# @param recording_sid [String]
|
4195
|
+
# @param [Hash] opts the optional parameters
|
4196
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
4197
|
+
def listened_pbx_agent_voicemail_with_http_info(recording_sid, opts = {})
|
4198
|
+
if @api_client.config.debugging
|
4199
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.listened_pbx_agent_voicemail ...'
|
4200
|
+
end
|
4201
|
+
# verify the required parameter 'recording_sid' is set
|
4202
|
+
if @api_client.config.client_side_validation && recording_sid.nil?
|
4203
|
+
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.listened_pbx_agent_voicemail"
|
4204
|
+
end
|
4205
|
+
# resource path
|
4206
|
+
local_var_path = '/conversation/pbx/agent/voicemails/{recording_sid}/listened'.sub('{' + 'recording_sid' + '}', CGI.escape(recording_sid.to_s))
|
4207
|
+
|
4208
|
+
# query parameters
|
4209
|
+
query_params = opts[:query_params] || {}
|
4210
|
+
|
4211
|
+
# header parameters
|
4212
|
+
header_params = opts[:header_params] || {}
|
4213
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
4214
|
+
# HTTP header 'Accept' (if needed)
|
4215
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4216
|
+
|
4217
|
+
# form parameters
|
4218
|
+
form_params = opts[:form_params] || {}
|
4219
|
+
|
4220
|
+
# http body (model)
|
4221
|
+
post_body = opts[:debug_body]
|
4222
|
+
|
4223
|
+
# return_type
|
4224
|
+
return_type = opts[:debug_return_type]
|
4225
|
+
|
4226
|
+
# auth_names
|
4227
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
4228
|
+
|
4229
|
+
new_options = opts.merge(
|
4230
|
+
:operation => :"ConversationApi.listened_pbx_agent_voicemail",
|
4231
|
+
:header_params => header_params,
|
4232
|
+
:query_params => query_params,
|
4233
|
+
:form_params => form_params,
|
4234
|
+
:body => post_body,
|
4235
|
+
:auth_names => auth_names,
|
4236
|
+
:return_type => return_type
|
4237
|
+
)
|
4238
|
+
|
4239
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
4240
|
+
if @api_client.config.debugging
|
4241
|
+
@api_client.config.logger.debug "API called: ConversationApi#listened_pbx_agent_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4242
|
+
end
|
4243
|
+
return data, status_code, headers
|
4244
|
+
end
|
4245
|
+
|
3862
4246
|
# Mark a conversation as read
|
3863
4247
|
# Mark a conversation as read
|
3864
4248
|
# @param conversation_uuid [String]
|
@@ -65,6 +65,9 @@ module UltracartClient
|
|
65
65
|
|
66
66
|
attr_accessor :management
|
67
67
|
|
68
|
+
# UltraCart merchant ID owning this order
|
69
|
+
attr_accessor :merchant_id
|
70
|
+
|
68
71
|
# The next time that the auto order will be attempted for processing
|
69
72
|
attr_accessor :next_attempt
|
70
73
|
|
@@ -127,6 +130,7 @@ module UltracartClient
|
|
127
130
|
:'items' => :'items',
|
128
131
|
:'logs' => :'logs',
|
129
132
|
:'management' => :'management',
|
133
|
+
:'merchant_id' => :'merchant_id',
|
130
134
|
:'next_attempt' => :'next_attempt',
|
131
135
|
:'original_order' => :'original_order',
|
132
136
|
:'original_order_id' => :'original_order_id',
|
@@ -162,6 +166,7 @@ module UltracartClient
|
|
162
166
|
:'items' => :'Array<AutoOrderItem>',
|
163
167
|
:'logs' => :'Array<AutoOrderLog>',
|
164
168
|
:'management' => :'AutoOrderManagement',
|
169
|
+
:'merchant_id' => :'String',
|
165
170
|
:'next_attempt' => :'String',
|
166
171
|
:'original_order' => :'Order',
|
167
172
|
:'original_order_id' => :'String',
|
@@ -267,6 +272,10 @@ module UltracartClient
|
|
267
272
|
self.management = attributes[:'management']
|
268
273
|
end
|
269
274
|
|
275
|
+
if attributes.key?(:'merchant_id')
|
276
|
+
self.merchant_id = attributes[:'merchant_id']
|
277
|
+
end
|
278
|
+
|
270
279
|
if attributes.key?(:'next_attempt')
|
271
280
|
self.next_attempt = attributes[:'next_attempt']
|
272
281
|
end
|
@@ -345,6 +354,7 @@ module UltracartClient
|
|
345
354
|
items == o.items &&
|
346
355
|
logs == o.logs &&
|
347
356
|
management == o.management &&
|
357
|
+
merchant_id == o.merchant_id &&
|
348
358
|
next_attempt == o.next_attempt &&
|
349
359
|
original_order == o.original_order &&
|
350
360
|
original_order_id == o.original_order_id &&
|
@@ -363,7 +373,7 @@ module UltracartClient
|
|
363
373
|
# Calculates hash code according to all attributes.
|
364
374
|
# @return [Integer] Hash code
|
365
375
|
def hash
|
366
|
-
[add_ons, auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, management, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
|
376
|
+
[add_ons, auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, management, merchant_id, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
|
367
377
|
end
|
368
378
|
|
369
379
|
# Builds the object from hash
|
@@ -51,6 +51,9 @@ module UltracartClient
|
|
51
51
|
# The life time value of this item including the original purchase
|
52
52
|
attr_accessor :life_time_value
|
53
53
|
|
54
|
+
# Calculated next item id
|
55
|
+
attr_accessor :next_item_id
|
56
|
+
|
54
57
|
# The date/time of when the next pre-shipment notice should be sent
|
55
58
|
attr_accessor :next_preshipment_notice_dts
|
56
59
|
|
@@ -129,6 +132,7 @@ module UltracartClient
|
|
129
132
|
:'future_schedules' => :'future_schedules',
|
130
133
|
:'last_order_dts' => :'last_order_dts',
|
131
134
|
:'life_time_value' => :'life_time_value',
|
135
|
+
:'next_item_id' => :'next_item_id',
|
132
136
|
:'next_preshipment_notice_dts' => :'next_preshipment_notice_dts',
|
133
137
|
:'next_shipment_dts' => :'next_shipment_dts',
|
134
138
|
:'no_order_after_dts' => :'no_order_after_dts',
|
@@ -166,6 +170,7 @@ module UltracartClient
|
|
166
170
|
:'future_schedules' => :'Array<AutoOrderItemFutureSchedule>',
|
167
171
|
:'last_order_dts' => :'String',
|
168
172
|
:'life_time_value' => :'Float',
|
173
|
+
:'next_item_id' => :'String',
|
169
174
|
:'next_preshipment_notice_dts' => :'String',
|
170
175
|
:'next_shipment_dts' => :'String',
|
171
176
|
:'no_order_after_dts' => :'String',
|
@@ -254,6 +259,10 @@ module UltracartClient
|
|
254
259
|
self.life_time_value = attributes[:'life_time_value']
|
255
260
|
end
|
256
261
|
|
262
|
+
if attributes.key?(:'next_item_id')
|
263
|
+
self.next_item_id = attributes[:'next_item_id']
|
264
|
+
end
|
265
|
+
|
257
266
|
if attributes.key?(:'next_preshipment_notice_dts')
|
258
267
|
self.next_preshipment_notice_dts = attributes[:'next_preshipment_notice_dts']
|
259
268
|
end
|
@@ -355,6 +364,7 @@ module UltracartClient
|
|
355
364
|
future_schedules == o.future_schedules &&
|
356
365
|
last_order_dts == o.last_order_dts &&
|
357
366
|
life_time_value == o.life_time_value &&
|
367
|
+
next_item_id == o.next_item_id &&
|
358
368
|
next_preshipment_notice_dts == o.next_preshipment_notice_dts &&
|
359
369
|
next_shipment_dts == o.next_shipment_dts &&
|
360
370
|
no_order_after_dts == o.no_order_after_dts &&
|
@@ -380,7 +390,7 @@ module UltracartClient
|
|
380
390
|
# Calculates hash code according to all attributes.
|
381
391
|
# @return [Integer] Hash code
|
382
392
|
def hash
|
383
|
-
[arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, first_order_dts, frequency, future_schedules, last_order_dts, life_time_value, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paused, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, rebill_value, remaining_repeat_count, simple_schedule].hash
|
393
|
+
[arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, first_order_dts, frequency, future_schedules, last_order_dts, life_time_value, next_item_id, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paused, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, rebill_value, remaining_repeat_count, simple_schedule].hash
|
384
394
|
end
|
385
395
|
|
386
396
|
# Builds the object from hash
|