ultracart_api 4.0.96.rc → 4.0.97.rc
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +18 -4
- data/docs/ConversationApi.md +439 -5
- data/docs/ConversationCannedMessage.md +1 -1
- data/docs/ConversationDepartment.md +26 -0
- data/docs/ConversationDepartmentResponse.md +26 -0
- data/docs/ConversationDepartmentsResponse.md +26 -0
- data/docs/ConversationEngagement.md +30 -0
- data/docs/ConversationEngagementResponse.md +26 -0
- data/docs/ConversationEngagementsResponse.md +26 -0
- data/docs/ConversationJoinRequest.md +18 -0
- data/docs/ConversationParticipant.md +4 -0
- data/docs/ConversationWebchatQueueStatusQueueEntry.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +412 -1
- data/lib/ultracart_api/models/conversation_canned_message.rb +1 -1
- data/lib/ultracart_api/models/conversation_department.rb +255 -0
- data/lib/ultracart_api/models/conversation_department_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_departments_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_engagement.rb +275 -0
- data/lib/ultracart_api/models/conversation_engagement_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_engagements_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_join_request.rb +219 -0
- data/lib/ultracart_api/models/conversation_participant.rb +19 -1
- data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +10 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +7 -0
- metadata +16 -2
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationDepartmentsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_departments** | [**Array<ConversationDepartment>**](ConversationDepartment.md) | | [optional] |
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationDepartmentsResponse.new(
|
19
|
+
conversation_departments: null,
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# UltracartClient::ConversationEngagement
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_engagement_oid** | **Integer** | | [optional] |
|
8
|
+
| **customer_greeting** | **String** | | [optional] |
|
9
|
+
| **department_oids** | **Array<Integer>** | | [optional] |
|
10
|
+
| **engagement_name** | **String** | | [optional] |
|
11
|
+
| **equation** | **Object** | | [optional] |
|
12
|
+
| **time_on_page** | **Integer** | | [optional] |
|
13
|
+
| **visitor_type** | **String** | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ultracart_api'
|
19
|
+
|
20
|
+
instance = UltracartClient::ConversationEngagement.new(
|
21
|
+
conversation_engagement_oid: null,
|
22
|
+
customer_greeting: null,
|
23
|
+
department_oids: null,
|
24
|
+
engagement_name: null,
|
25
|
+
equation: null,
|
26
|
+
time_on_page: null,
|
27
|
+
visitor_type: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationEngagementResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_engagement** | [**ConversationEngagement**](ConversationEngagement.md) | | [optional] |
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationEngagementResponse.new(
|
19
|
+
conversation_engagement: null,
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationEngagementsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_engagements** | [**Array<ConversationEngagement>**](ConversationEngagement.md) | | [optional] |
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationEngagementsResponse.new(
|
19
|
+
conversation_engagements: null,
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UltracartClient::ConversationJoinRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **participant_language_iso_code** | **String** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ultracart_api'
|
13
|
+
|
14
|
+
instance = UltracartClient::ConversationJoinRequest.new(
|
15
|
+
participant_language_iso_code: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -7,11 +7,13 @@
|
|
7
7
|
| **conversation_participant_arn** | **String** | | [optional] |
|
8
8
|
| **conversation_participant_name** | **String** | | [optional] |
|
9
9
|
| **conversation_participant_uuid** | **String** | | [optional] |
|
10
|
+
| **email** | **String** | | [optional] |
|
10
11
|
| **joined_dts** | **String** | Joined conversation date/time | [optional] |
|
11
12
|
| **language_iso_code** | **String** | | [optional] |
|
12
13
|
| **last_message_dts** | **String** | Last message date/time | [optional] |
|
13
14
|
| **left_dts** | **String** | Left conversation date/time | [optional] |
|
14
15
|
| **profile_image_url** | **String** | | [optional] |
|
16
|
+
| **sms_phone_number** | **String** | | [optional] |
|
15
17
|
| **status** | **String** | | [optional] |
|
16
18
|
| **timezone** | **String** | | [optional] |
|
17
19
|
| **unread_messages** | **Integer** | | [optional] |
|
@@ -25,11 +27,13 @@ instance = UltracartClient::ConversationParticipant.new(
|
|
25
27
|
conversation_participant_arn: null,
|
26
28
|
conversation_participant_name: null,
|
27
29
|
conversation_participant_uuid: null,
|
30
|
+
email: null,
|
28
31
|
joined_dts: null,
|
29
32
|
language_iso_code: null,
|
30
33
|
last_message_dts: null,
|
31
34
|
left_dts: null,
|
32
35
|
profile_image_url: null,
|
36
|
+
sms_phone_number: null,
|
33
37
|
status: null,
|
34
38
|
timezone: null,
|
35
39
|
unread_messages: null
|
@@ -9,6 +9,7 @@
|
|
9
9
|
| **conversation_webchat_queue_uuid** | **String** | | [optional] |
|
10
10
|
| **email** | **String** | | [optional] |
|
11
11
|
| **join_dts** | **String** | Date/time the customer joined the queue | [optional] |
|
12
|
+
| **participant_language_iso_code** | **String** | | [optional] |
|
12
13
|
| **question** | **String** | | [optional] |
|
13
14
|
|
14
15
|
## Example
|
@@ -22,6 +23,7 @@ instance = UltracartClient::ConversationWebchatQueueStatusQueueEntry.new(
|
|
22
23
|
conversation_webchat_queue_uuid: null,
|
23
24
|
email: null,
|
24
25
|
join_dts: null,
|
26
|
+
participant_language_iso_code: null,
|
25
27
|
question: null
|
26
28
|
)
|
27
29
|
```
|
@@ -337,6 +337,122 @@ module UltracartClient
|
|
337
337
|
return data, status_code, headers
|
338
338
|
end
|
339
339
|
|
340
|
+
# Retrieve a list of departments ordered by name
|
341
|
+
# Retrieve a list of departments ordered by name
|
342
|
+
# @param [Hash] opts the optional parameters
|
343
|
+
# @return [ConversationDepartmentsResponse]
|
344
|
+
def get_conversation_departments(opts = {})
|
345
|
+
data, _status_code, _headers = get_conversation_departments_with_http_info(opts)
|
346
|
+
data
|
347
|
+
end
|
348
|
+
|
349
|
+
# Retrieve a list of departments ordered by name
|
350
|
+
# Retrieve a list of departments ordered by name
|
351
|
+
# @param [Hash] opts the optional parameters
|
352
|
+
# @return [Array<(ConversationDepartmentsResponse, Integer, Hash)>] ConversationDepartmentsResponse data, response status code and response headers
|
353
|
+
def get_conversation_departments_with_http_info(opts = {})
|
354
|
+
if @api_client.config.debugging
|
355
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_departments ...'
|
356
|
+
end
|
357
|
+
# resource path
|
358
|
+
local_var_path = '/conversation/departments'
|
359
|
+
|
360
|
+
# query parameters
|
361
|
+
query_params = opts[:query_params] || {}
|
362
|
+
|
363
|
+
# header parameters
|
364
|
+
header_params = opts[:header_params] || {}
|
365
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
366
|
+
# HTTP header 'Accept' (if needed)
|
367
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
368
|
+
|
369
|
+
# form parameters
|
370
|
+
form_params = opts[:form_params] || {}
|
371
|
+
|
372
|
+
# http body (model)
|
373
|
+
post_body = opts[:debug_body]
|
374
|
+
|
375
|
+
# return_type
|
376
|
+
return_type = opts[:debug_return_type] || 'ConversationDepartmentsResponse'
|
377
|
+
|
378
|
+
# auth_names
|
379
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
380
|
+
|
381
|
+
new_options = opts.merge(
|
382
|
+
:operation => :"ConversationApi.get_conversation_departments",
|
383
|
+
:header_params => header_params,
|
384
|
+
:query_params => query_params,
|
385
|
+
:form_params => form_params,
|
386
|
+
:body => post_body,
|
387
|
+
:auth_names => auth_names,
|
388
|
+
:return_type => return_type
|
389
|
+
)
|
390
|
+
|
391
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
392
|
+
if @api_client.config.debugging
|
393
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_departments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
394
|
+
end
|
395
|
+
return data, status_code, headers
|
396
|
+
end
|
397
|
+
|
398
|
+
# Retrieve a list of engagements ordered by name
|
399
|
+
# Retrieve a list of engagements ordered by name
|
400
|
+
# @param [Hash] opts the optional parameters
|
401
|
+
# @return [ConversationEngagementsResponse]
|
402
|
+
def get_conversation_engagements(opts = {})
|
403
|
+
data, _status_code, _headers = get_conversation_engagements_with_http_info(opts)
|
404
|
+
data
|
405
|
+
end
|
406
|
+
|
407
|
+
# Retrieve a list of engagements ordered by name
|
408
|
+
# Retrieve a list of engagements ordered by name
|
409
|
+
# @param [Hash] opts the optional parameters
|
410
|
+
# @return [Array<(ConversationEngagementsResponse, Integer, Hash)>] ConversationEngagementsResponse data, response status code and response headers
|
411
|
+
def get_conversation_engagements_with_http_info(opts = {})
|
412
|
+
if @api_client.config.debugging
|
413
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagements ...'
|
414
|
+
end
|
415
|
+
# resource path
|
416
|
+
local_var_path = '/conversation/engagements'
|
417
|
+
|
418
|
+
# query parameters
|
419
|
+
query_params = opts[:query_params] || {}
|
420
|
+
|
421
|
+
# header parameters
|
422
|
+
header_params = opts[:header_params] || {}
|
423
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
424
|
+
# HTTP header 'Accept' (if needed)
|
425
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
426
|
+
|
427
|
+
# form parameters
|
428
|
+
form_params = opts[:form_params] || {}
|
429
|
+
|
430
|
+
# http body (model)
|
431
|
+
post_body = opts[:debug_body]
|
432
|
+
|
433
|
+
# return_type
|
434
|
+
return_type = opts[:debug_return_type] || 'ConversationEngagementsResponse'
|
435
|
+
|
436
|
+
# auth_names
|
437
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
438
|
+
|
439
|
+
new_options = opts.merge(
|
440
|
+
:operation => :"ConversationApi.get_conversation_engagements",
|
441
|
+
:header_params => header_params,
|
442
|
+
:query_params => query_params,
|
443
|
+
:form_params => form_params,
|
444
|
+
:body => post_body,
|
445
|
+
:auth_names => auth_names,
|
446
|
+
:return_type => return_type
|
447
|
+
)
|
448
|
+
|
449
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
450
|
+
if @api_client.config.debugging
|
451
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
452
|
+
end
|
453
|
+
return data, status_code, headers
|
454
|
+
end
|
455
|
+
|
340
456
|
# Retrieve conversation messages
|
341
457
|
# Retrieve conversation messages since a particular time
|
342
458
|
# @param conversation_uuid [String]
|
@@ -671,10 +787,149 @@ module UltracartClient
|
|
671
787
|
return data, status_code, headers
|
672
788
|
end
|
673
789
|
|
790
|
+
# Insert a department
|
791
|
+
# Insert a department
|
792
|
+
# @param department [ConversationDepartment] Department
|
793
|
+
# @param [Hash] opts the optional parameters
|
794
|
+
# @return [ConversationDepartmentResponse]
|
795
|
+
def insert_conversation_department(department, opts = {})
|
796
|
+
data, _status_code, _headers = insert_conversation_department_with_http_info(department, opts)
|
797
|
+
data
|
798
|
+
end
|
799
|
+
|
800
|
+
# Insert a department
|
801
|
+
# Insert a department
|
802
|
+
# @param department [ConversationDepartment] Department
|
803
|
+
# @param [Hash] opts the optional parameters
|
804
|
+
# @return [Array<(ConversationDepartmentResponse, Integer, Hash)>] ConversationDepartmentResponse data, response status code and response headers
|
805
|
+
def insert_conversation_department_with_http_info(department, opts = {})
|
806
|
+
if @api_client.config.debugging
|
807
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_department ...'
|
808
|
+
end
|
809
|
+
# verify the required parameter 'department' is set
|
810
|
+
if @api_client.config.client_side_validation && department.nil?
|
811
|
+
fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.insert_conversation_department"
|
812
|
+
end
|
813
|
+
# resource path
|
814
|
+
local_var_path = '/conversation/departments'
|
815
|
+
|
816
|
+
# query parameters
|
817
|
+
query_params = opts[:query_params] || {}
|
818
|
+
|
819
|
+
# header parameters
|
820
|
+
header_params = opts[:header_params] || {}
|
821
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
822
|
+
# HTTP header 'Accept' (if needed)
|
823
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
824
|
+
# HTTP header 'Content-Type'
|
825
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
826
|
+
if !content_type.nil?
|
827
|
+
header_params['Content-Type'] = content_type
|
828
|
+
end
|
829
|
+
|
830
|
+
# form parameters
|
831
|
+
form_params = opts[:form_params] || {}
|
832
|
+
|
833
|
+
# http body (model)
|
834
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(department)
|
835
|
+
|
836
|
+
# return_type
|
837
|
+
return_type = opts[:debug_return_type] || 'ConversationDepartmentResponse'
|
838
|
+
|
839
|
+
# auth_names
|
840
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
841
|
+
|
842
|
+
new_options = opts.merge(
|
843
|
+
:operation => :"ConversationApi.insert_conversation_department",
|
844
|
+
:header_params => header_params,
|
845
|
+
:query_params => query_params,
|
846
|
+
:form_params => form_params,
|
847
|
+
:body => post_body,
|
848
|
+
:auth_names => auth_names,
|
849
|
+
:return_type => return_type
|
850
|
+
)
|
851
|
+
|
852
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
853
|
+
if @api_client.config.debugging
|
854
|
+
@api_client.config.logger.debug "API called: ConversationApi#insert_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
855
|
+
end
|
856
|
+
return data, status_code, headers
|
857
|
+
end
|
858
|
+
|
859
|
+
# Insert a engagement
|
860
|
+
# Insert a engagement
|
861
|
+
# @param engagement [ConversationEngagement] Engagement
|
862
|
+
# @param [Hash] opts the optional parameters
|
863
|
+
# @return [ConversationEngagementResponse]
|
864
|
+
def insert_conversation_engagement(engagement, opts = {})
|
865
|
+
data, _status_code, _headers = insert_conversation_engagement_with_http_info(engagement, opts)
|
866
|
+
data
|
867
|
+
end
|
868
|
+
|
869
|
+
# Insert a engagement
|
870
|
+
# Insert a engagement
|
871
|
+
# @param engagement [ConversationEngagement] Engagement
|
872
|
+
# @param [Hash] opts the optional parameters
|
873
|
+
# @return [Array<(ConversationEngagementResponse, Integer, Hash)>] ConversationEngagementResponse data, response status code and response headers
|
874
|
+
def insert_conversation_engagement_with_http_info(engagement, opts = {})
|
875
|
+
if @api_client.config.debugging
|
876
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_engagement ...'
|
877
|
+
end
|
878
|
+
# verify the required parameter 'engagement' is set
|
879
|
+
if @api_client.config.client_side_validation && engagement.nil?
|
880
|
+
fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.insert_conversation_engagement"
|
881
|
+
end
|
882
|
+
# resource path
|
883
|
+
local_var_path = '/conversation/engagements'
|
884
|
+
|
885
|
+
# query parameters
|
886
|
+
query_params = opts[:query_params] || {}
|
887
|
+
|
888
|
+
# header parameters
|
889
|
+
header_params = opts[:header_params] || {}
|
890
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
891
|
+
# HTTP header 'Accept' (if needed)
|
892
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
893
|
+
# HTTP header 'Content-Type'
|
894
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
895
|
+
if !content_type.nil?
|
896
|
+
header_params['Content-Type'] = content_type
|
897
|
+
end
|
898
|
+
|
899
|
+
# form parameters
|
900
|
+
form_params = opts[:form_params] || {}
|
901
|
+
|
902
|
+
# http body (model)
|
903
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(engagement)
|
904
|
+
|
905
|
+
# return_type
|
906
|
+
return_type = opts[:debug_return_type] || 'ConversationEngagementResponse'
|
907
|
+
|
908
|
+
# auth_names
|
909
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
910
|
+
|
911
|
+
new_options = opts.merge(
|
912
|
+
:operation => :"ConversationApi.insert_conversation_engagement",
|
913
|
+
:header_params => header_params,
|
914
|
+
:query_params => query_params,
|
915
|
+
:form_params => form_params,
|
916
|
+
:body => post_body,
|
917
|
+
:auth_names => auth_names,
|
918
|
+
:return_type => return_type
|
919
|
+
)
|
920
|
+
|
921
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
922
|
+
if @api_client.config.debugging
|
923
|
+
@api_client.config.logger.debug "API called: ConversationApi#insert_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
924
|
+
end
|
925
|
+
return data, status_code, headers
|
926
|
+
end
|
927
|
+
|
674
928
|
# Join a conversation
|
675
929
|
# Join a conversation
|
676
930
|
# @param conversation_uuid [String]
|
677
931
|
# @param [Hash] opts the optional parameters
|
932
|
+
# @option opts [ConversationJoinRequest] :join_request Join request
|
678
933
|
# @return [nil]
|
679
934
|
def join_conversation(conversation_uuid, opts = {})
|
680
935
|
join_conversation_with_http_info(conversation_uuid, opts)
|
@@ -685,6 +940,7 @@ module UltracartClient
|
|
685
940
|
# Join a conversation
|
686
941
|
# @param conversation_uuid [String]
|
687
942
|
# @param [Hash] opts the optional parameters
|
943
|
+
# @option opts [ConversationJoinRequest] :join_request Join request
|
688
944
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
689
945
|
def join_conversation_with_http_info(conversation_uuid, opts = {})
|
690
946
|
if @api_client.config.debugging
|
@@ -705,12 +961,17 @@ module UltracartClient
|
|
705
961
|
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
706
962
|
# HTTP header 'Accept' (if needed)
|
707
963
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
964
|
+
# HTTP header 'Content-Type'
|
965
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
966
|
+
if !content_type.nil?
|
967
|
+
header_params['Content-Type'] = content_type
|
968
|
+
end
|
708
969
|
|
709
970
|
# form parameters
|
710
971
|
form_params = opts[:form_params] || {}
|
711
972
|
|
712
973
|
# http body (model)
|
713
|
-
post_body = opts[:debug_body]
|
974
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'join_request'])
|
714
975
|
|
715
976
|
# return_type
|
716
977
|
return_type = opts[:debug_return_type]
|
@@ -1076,6 +1337,156 @@ module UltracartClient
|
|
1076
1337
|
return data, status_code, headers
|
1077
1338
|
end
|
1078
1339
|
|
1340
|
+
# Update a department
|
1341
|
+
# Update a department
|
1342
|
+
# @param conversation_department_oid [Integer]
|
1343
|
+
# @param department [ConversationDepartment] Department
|
1344
|
+
# @param [Hash] opts the optional parameters
|
1345
|
+
# @return [ConversationDepartmentResponse]
|
1346
|
+
def update_conversation_department(conversation_department_oid, department, opts = {})
|
1347
|
+
data, _status_code, _headers = update_conversation_department_with_http_info(conversation_department_oid, department, opts)
|
1348
|
+
data
|
1349
|
+
end
|
1350
|
+
|
1351
|
+
# Update a department
|
1352
|
+
# Update a department
|
1353
|
+
# @param conversation_department_oid [Integer]
|
1354
|
+
# @param department [ConversationDepartment] Department
|
1355
|
+
# @param [Hash] opts the optional parameters
|
1356
|
+
# @return [Array<(ConversationDepartmentResponse, Integer, Hash)>] ConversationDepartmentResponse data, response status code and response headers
|
1357
|
+
def update_conversation_department_with_http_info(conversation_department_oid, department, opts = {})
|
1358
|
+
if @api_client.config.debugging
|
1359
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_department ...'
|
1360
|
+
end
|
1361
|
+
# verify the required parameter 'conversation_department_oid' is set
|
1362
|
+
if @api_client.config.client_side_validation && conversation_department_oid.nil?
|
1363
|
+
fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.update_conversation_department"
|
1364
|
+
end
|
1365
|
+
# verify the required parameter 'department' is set
|
1366
|
+
if @api_client.config.client_side_validation && department.nil?
|
1367
|
+
fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.update_conversation_department"
|
1368
|
+
end
|
1369
|
+
# resource path
|
1370
|
+
local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', CGI.escape(conversation_department_oid.to_s))
|
1371
|
+
|
1372
|
+
# query parameters
|
1373
|
+
query_params = opts[:query_params] || {}
|
1374
|
+
|
1375
|
+
# header parameters
|
1376
|
+
header_params = opts[:header_params] || {}
|
1377
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1378
|
+
# HTTP header 'Accept' (if needed)
|
1379
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1380
|
+
# HTTP header 'Content-Type'
|
1381
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
1382
|
+
if !content_type.nil?
|
1383
|
+
header_params['Content-Type'] = content_type
|
1384
|
+
end
|
1385
|
+
|
1386
|
+
# form parameters
|
1387
|
+
form_params = opts[:form_params] || {}
|
1388
|
+
|
1389
|
+
# http body (model)
|
1390
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(department)
|
1391
|
+
|
1392
|
+
# return_type
|
1393
|
+
return_type = opts[:debug_return_type] || 'ConversationDepartmentResponse'
|
1394
|
+
|
1395
|
+
# auth_names
|
1396
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1397
|
+
|
1398
|
+
new_options = opts.merge(
|
1399
|
+
:operation => :"ConversationApi.update_conversation_department",
|
1400
|
+
:header_params => header_params,
|
1401
|
+
:query_params => query_params,
|
1402
|
+
:form_params => form_params,
|
1403
|
+
:body => post_body,
|
1404
|
+
:auth_names => auth_names,
|
1405
|
+
:return_type => return_type
|
1406
|
+
)
|
1407
|
+
|
1408
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
1409
|
+
if @api_client.config.debugging
|
1410
|
+
@api_client.config.logger.debug "API called: ConversationApi#update_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1411
|
+
end
|
1412
|
+
return data, status_code, headers
|
1413
|
+
end
|
1414
|
+
|
1415
|
+
# Update a engagement
|
1416
|
+
# Update a engagement
|
1417
|
+
# @param conversation_engagement_oid [Integer]
|
1418
|
+
# @param engagement [ConversationEngagement] Engagement
|
1419
|
+
# @param [Hash] opts the optional parameters
|
1420
|
+
# @return [ConversationEngagementResponse]
|
1421
|
+
def update_conversation_engagement(conversation_engagement_oid, engagement, opts = {})
|
1422
|
+
data, _status_code, _headers = update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts)
|
1423
|
+
data
|
1424
|
+
end
|
1425
|
+
|
1426
|
+
# Update a engagement
|
1427
|
+
# Update a engagement
|
1428
|
+
# @param conversation_engagement_oid [Integer]
|
1429
|
+
# @param engagement [ConversationEngagement] Engagement
|
1430
|
+
# @param [Hash] opts the optional parameters
|
1431
|
+
# @return [Array<(ConversationEngagementResponse, Integer, Hash)>] ConversationEngagementResponse data, response status code and response headers
|
1432
|
+
def update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts = {})
|
1433
|
+
if @api_client.config.debugging
|
1434
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_engagement ...'
|
1435
|
+
end
|
1436
|
+
# verify the required parameter 'conversation_engagement_oid' is set
|
1437
|
+
if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
|
1438
|
+
fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.update_conversation_engagement"
|
1439
|
+
end
|
1440
|
+
# verify the required parameter 'engagement' is set
|
1441
|
+
if @api_client.config.client_side_validation && engagement.nil?
|
1442
|
+
fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.update_conversation_engagement"
|
1443
|
+
end
|
1444
|
+
# resource path
|
1445
|
+
local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', CGI.escape(conversation_engagement_oid.to_s))
|
1446
|
+
|
1447
|
+
# query parameters
|
1448
|
+
query_params = opts[:query_params] || {}
|
1449
|
+
|
1450
|
+
# header parameters
|
1451
|
+
header_params = opts[:header_params] || {}
|
1452
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1453
|
+
# HTTP header 'Accept' (if needed)
|
1454
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1455
|
+
# HTTP header 'Content-Type'
|
1456
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
1457
|
+
if !content_type.nil?
|
1458
|
+
header_params['Content-Type'] = content_type
|
1459
|
+
end
|
1460
|
+
|
1461
|
+
# form parameters
|
1462
|
+
form_params = opts[:form_params] || {}
|
1463
|
+
|
1464
|
+
# http body (model)
|
1465
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(engagement)
|
1466
|
+
|
1467
|
+
# return_type
|
1468
|
+
return_type = opts[:debug_return_type] || 'ConversationEngagementResponse'
|
1469
|
+
|
1470
|
+
# auth_names
|
1471
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1472
|
+
|
1473
|
+
new_options = opts.merge(
|
1474
|
+
:operation => :"ConversationApi.update_conversation_engagement",
|
1475
|
+
:header_params => header_params,
|
1476
|
+
:query_params => query_params,
|
1477
|
+
:form_params => form_params,
|
1478
|
+
:body => post_body,
|
1479
|
+
:auth_names => auth_names,
|
1480
|
+
:return_type => return_type
|
1481
|
+
)
|
1482
|
+
|
1483
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
1484
|
+
if @api_client.config.debugging
|
1485
|
+
@api_client.config.logger.debug "API called: ConversationApi#update_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1486
|
+
end
|
1487
|
+
return data, status_code, headers
|
1488
|
+
end
|
1489
|
+
|
1079
1490
|
# Update status within the queue
|
1080
1491
|
# Update status within the queue
|
1081
1492
|
# @param queue_name [String]
|
@@ -43,7 +43,7 @@ module UltracartClient
|
|
43
43
|
{
|
44
44
|
:'canned_message' => :'String',
|
45
45
|
:'conversation_canned_message_oid' => :'Integer',
|
46
|
-
:'conversation_department_oids' => :'Array<
|
46
|
+
:'conversation_department_oids' => :'Array<Integer>',
|
47
47
|
:'short_code' => :'String'
|
48
48
|
}
|
49
49
|
end
|