ultracart_api 3.10.79 → 3.10.81
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +27 -4
- data/docs/ConversationApi.md +410 -2
- data/docs/ConversationAutocompleteRequest.md +9 -0
- data/docs/ConversationAutocompleteResponse.md +14 -0
- data/docs/ConversationCannedMessage.md +1 -1
- data/docs/ConversationDepartment.md +12 -0
- data/docs/ConversationDepartmentResponse.md +12 -0
- data/docs/ConversationDepartmentSettings.md +7 -0
- data/docs/ConversationDepartmentsResponse.md +12 -0
- data/docs/ConversationEngagement.md +14 -0
- data/docs/ConversationEngagementEquation.md +7 -0
- data/docs/ConversationEngagementResponse.md +12 -0
- data/docs/ConversationEngagementsResponse.md +12 -0
- data/docs/ConversationJoinRequest.md +8 -0
- data/docs/ConversationParticipant.md +2 -0
- data/docs/ConversationSearchRequest.md +17 -0
- data/docs/ConversationSearchResponse.md +10 -0
- data/docs/ConversationWebchatQueueStatusQueueEntry.md +1 -0
- data/lib/ultracart_api/api/conversation_api.rb +443 -1
- data/lib/ultracart_api/models/conversation_autocomplete_request.rb +193 -0
- data/lib/ultracart_api/models/conversation_autocomplete_response.rb +241 -0
- data/lib/ultracart_api/models/conversation_canned_message.rb +1 -1
- data/lib/ultracart_api/models/conversation_department.rb +220 -0
- data/lib/ultracart_api/models/conversation_department_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_department_settings.rb +175 -0
- data/lib/ultracart_api/models/conversation_departments_response.rb +223 -0
- data/lib/ultracart_api/models/conversation_engagement.rb +240 -0
- data/lib/ultracart_api/models/conversation_engagement_equation.rb +175 -0
- data/lib/ultracart_api/models/conversation_engagement_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_engagements_response.rb +223 -0
- data/lib/ultracart_api/models/conversation_join_request.rb +184 -0
- data/lib/ultracart_api/models/conversation_participant.rb +19 -1
- data/lib/ultracart_api/models/conversation_search_request.rb +265 -0
- data/lib/ultracart_api/models/conversation_search_response.rb +202 -0
- 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 +13 -0
- metadata +28 -2
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::ConversationEngagement
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_engagement_oid** | **Integer** | | [optional]
|
7
|
+
**customer_greeting** | **String** | | [optional]
|
8
|
+
**department_oids** | **Array<Integer>** | | [optional]
|
9
|
+
**engagement_name** | **String** | | [optional]
|
10
|
+
**equation** | [**ConversationEngagementEquation**](ConversationEngagementEquation.md) | | [optional]
|
11
|
+
**time_on_page** | **Integer** | | [optional]
|
12
|
+
**visitor_type** | **String** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationEngagementResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_engagement** | [**ConversationEngagement**](ConversationEngagement.md) | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationEngagementsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_engagements** | [**Array<ConversationEngagement>**](ConversationEngagement.md) | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -6,11 +6,13 @@ Name | Type | Description | Notes
|
|
6
6
|
**conversation_participant_arn** | **String** | | [optional]
|
7
7
|
**conversation_participant_name** | **String** | | [optional]
|
8
8
|
**conversation_participant_uuid** | **String** | | [optional]
|
9
|
+
**email** | **String** | | [optional]
|
9
10
|
**joined_dts** | **String** | Joined conversation date/time | [optional]
|
10
11
|
**language_iso_code** | **String** | | [optional]
|
11
12
|
**last_message_dts** | **String** | Last message date/time | [optional]
|
12
13
|
**left_dts** | **String** | Left conversation date/time | [optional]
|
13
14
|
**profile_image_url** | **String** | | [optional]
|
15
|
+
**sms_phone_number** | **String** | | [optional]
|
14
16
|
**status** | **String** | | [optional]
|
15
17
|
**timezone** | **String** | | [optional]
|
16
18
|
**unread_messages** | **Integer** | | [optional]
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# UltracartClient::ConversationSearchRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email_filter** | **String** | | [optional]
|
7
|
+
**language_filter** | **String** | | [optional]
|
8
|
+
**medium_filter** | **String** | | [optional]
|
9
|
+
**order_by_newest** | **BOOLEAN** | | [optional]
|
10
|
+
**order_by_oldest** | **BOOLEAN** | | [optional]
|
11
|
+
**range_begin** | **Integer** | | [optional]
|
12
|
+
**range_end** | **Integer** | | [optional]
|
13
|
+
**sms_phone_number_filter** | **String** | | [optional]
|
14
|
+
**text_search** | **String** | | [optional]
|
15
|
+
**visible_filter** | **BOOLEAN** | | [optional]
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::ConversationSearchResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**range_begin** | **Integer** | | [optional]
|
7
|
+
**range_end** | **Integer** | | [optional]
|
8
|
+
**total** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**conversation_webchat_queue_uuid** | **String** | | [optional]
|
9
9
|
**email** | **String** | | [optional]
|
10
10
|
**join_dts** | **String** | Date/time the customer joined the queue | [optional]
|
11
|
+
**participant_language_iso_code** | **String** | | [optional]
|
11
12
|
**question** | **String** | | [optional]
|
12
13
|
|
13
14
|
|
@@ -291,6 +291,104 @@ module UltracartClient
|
|
291
291
|
end
|
292
292
|
return data, status_code, headers
|
293
293
|
end
|
294
|
+
# Retrieve a list of departments ordered by name
|
295
|
+
# Retrieve a list of departments ordered by name
|
296
|
+
# @param [Hash] opts the optional parameters
|
297
|
+
# @return [ConversationDepartmentsResponse]
|
298
|
+
def get_conversation_departments(opts = {})
|
299
|
+
data, _status_code, _headers = get_conversation_departments_with_http_info(opts)
|
300
|
+
data
|
301
|
+
end
|
302
|
+
|
303
|
+
# Retrieve a list of departments ordered by name
|
304
|
+
# Retrieve a list of departments ordered by name
|
305
|
+
# @param [Hash] opts the optional parameters
|
306
|
+
# @return [Array<(ConversationDepartmentsResponse, Fixnum, Hash)>] ConversationDepartmentsResponse data, response status code and response headers
|
307
|
+
def get_conversation_departments_with_http_info(opts = {})
|
308
|
+
if @api_client.config.debugging
|
309
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_departments ...'
|
310
|
+
end
|
311
|
+
# resource path
|
312
|
+
local_var_path = '/conversation/departments'
|
313
|
+
|
314
|
+
# query parameters
|
315
|
+
query_params = {}
|
316
|
+
|
317
|
+
# header parameters
|
318
|
+
header_params = {}
|
319
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
320
|
+
# HTTP header 'Accept' (if needed)
|
321
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
322
|
+
# HTTP header 'Content-Type'
|
323
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
324
|
+
|
325
|
+
# form parameters
|
326
|
+
form_params = {}
|
327
|
+
|
328
|
+
# http body (model)
|
329
|
+
post_body = nil
|
330
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
331
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
332
|
+
:header_params => header_params,
|
333
|
+
:query_params => query_params,
|
334
|
+
:form_params => form_params,
|
335
|
+
:body => post_body,
|
336
|
+
:auth_names => auth_names,
|
337
|
+
:return_type => 'ConversationDepartmentsResponse')
|
338
|
+
if @api_client.config.debugging
|
339
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_departments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
340
|
+
end
|
341
|
+
return data, status_code, headers
|
342
|
+
end
|
343
|
+
# Retrieve a list of engagements ordered by name
|
344
|
+
# Retrieve a list of engagements ordered by name
|
345
|
+
# @param [Hash] opts the optional parameters
|
346
|
+
# @return [ConversationEngagementsResponse]
|
347
|
+
def get_conversation_engagements(opts = {})
|
348
|
+
data, _status_code, _headers = get_conversation_engagements_with_http_info(opts)
|
349
|
+
data
|
350
|
+
end
|
351
|
+
|
352
|
+
# Retrieve a list of engagements ordered by name
|
353
|
+
# Retrieve a list of engagements ordered by name
|
354
|
+
# @param [Hash] opts the optional parameters
|
355
|
+
# @return [Array<(ConversationEngagementsResponse, Fixnum, Hash)>] ConversationEngagementsResponse data, response status code and response headers
|
356
|
+
def get_conversation_engagements_with_http_info(opts = {})
|
357
|
+
if @api_client.config.debugging
|
358
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagements ...'
|
359
|
+
end
|
360
|
+
# resource path
|
361
|
+
local_var_path = '/conversation/engagements'
|
362
|
+
|
363
|
+
# query parameters
|
364
|
+
query_params = {}
|
365
|
+
|
366
|
+
# header parameters
|
367
|
+
header_params = {}
|
368
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
369
|
+
# HTTP header 'Accept' (if needed)
|
370
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
371
|
+
# HTTP header 'Content-Type'
|
372
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
373
|
+
|
374
|
+
# form parameters
|
375
|
+
form_params = {}
|
376
|
+
|
377
|
+
# http body (model)
|
378
|
+
post_body = nil
|
379
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
380
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
381
|
+
:header_params => header_params,
|
382
|
+
:query_params => query_params,
|
383
|
+
:form_params => form_params,
|
384
|
+
:body => post_body,
|
385
|
+
:auth_names => auth_names,
|
386
|
+
:return_type => 'ConversationEngagementsResponse')
|
387
|
+
if @api_client.config.debugging
|
388
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
389
|
+
end
|
390
|
+
return data, status_code, headers
|
391
|
+
end
|
294
392
|
# Retrieve conversation messages
|
295
393
|
# Retrieve conversation messages since a particular time
|
296
394
|
# @param conversation_uuid
|
@@ -520,6 +618,116 @@ module UltracartClient
|
|
520
618
|
end
|
521
619
|
return data, status_code, headers
|
522
620
|
end
|
621
|
+
# Retrieve a list of matching terms for a search field
|
622
|
+
# Retrieve a list of matching terms for a search field
|
623
|
+
# @param autocomplete_request Autocomplete Request
|
624
|
+
# @param [Hash] opts the optional parameters
|
625
|
+
# @return [ConversationAutocompleteResponse]
|
626
|
+
def get_conversations_autocomplete(autocomplete_request, opts = {})
|
627
|
+
data, _status_code, _headers = get_conversations_autocomplete_with_http_info(autocomplete_request, opts)
|
628
|
+
data
|
629
|
+
end
|
630
|
+
|
631
|
+
# Retrieve a list of matching terms for a search field
|
632
|
+
# Retrieve a list of matching terms for a search field
|
633
|
+
# @param autocomplete_request Autocomplete Request
|
634
|
+
# @param [Hash] opts the optional parameters
|
635
|
+
# @return [Array<(ConversationAutocompleteResponse, Fixnum, Hash)>] ConversationAutocompleteResponse data, response status code and response headers
|
636
|
+
def get_conversations_autocomplete_with_http_info(autocomplete_request, opts = {})
|
637
|
+
if @api_client.config.debugging
|
638
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_autocomplete ...'
|
639
|
+
end
|
640
|
+
# verify the required parameter 'autocomplete_request' is set
|
641
|
+
if @api_client.config.client_side_validation && autocomplete_request.nil?
|
642
|
+
fail ArgumentError, "Missing the required parameter 'autocomplete_request' when calling ConversationApi.get_conversations_autocomplete"
|
643
|
+
end
|
644
|
+
# resource path
|
645
|
+
local_var_path = '/conversation/conversations/autocomplete'
|
646
|
+
|
647
|
+
# query parameters
|
648
|
+
query_params = {}
|
649
|
+
|
650
|
+
# header parameters
|
651
|
+
header_params = {}
|
652
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
653
|
+
# HTTP header 'Accept' (if needed)
|
654
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
655
|
+
# HTTP header 'Content-Type'
|
656
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
657
|
+
|
658
|
+
# form parameters
|
659
|
+
form_params = {}
|
660
|
+
|
661
|
+
# http body (model)
|
662
|
+
post_body = @api_client.object_to_http_body(autocomplete_request)
|
663
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
664
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
665
|
+
:header_params => header_params,
|
666
|
+
:query_params => query_params,
|
667
|
+
:form_params => form_params,
|
668
|
+
:body => post_body,
|
669
|
+
:auth_names => auth_names,
|
670
|
+
:return_type => 'ConversationAutocompleteResponse')
|
671
|
+
if @api_client.config.debugging
|
672
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversations_autocomplete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
673
|
+
end
|
674
|
+
return data, status_code, headers
|
675
|
+
end
|
676
|
+
# Search conversations
|
677
|
+
# Search conversations
|
678
|
+
# @param search_request Search Request
|
679
|
+
# @param [Hash] opts the optional parameters
|
680
|
+
# @return [ConversationSearchResponse]
|
681
|
+
def get_conversations_search(search_request, opts = {})
|
682
|
+
data, _status_code, _headers = get_conversations_search_with_http_info(search_request, opts)
|
683
|
+
data
|
684
|
+
end
|
685
|
+
|
686
|
+
# Search conversations
|
687
|
+
# Search conversations
|
688
|
+
# @param search_request Search Request
|
689
|
+
# @param [Hash] opts the optional parameters
|
690
|
+
# @return [Array<(ConversationSearchResponse, Fixnum, Hash)>] ConversationSearchResponse data, response status code and response headers
|
691
|
+
def get_conversations_search_with_http_info(search_request, opts = {})
|
692
|
+
if @api_client.config.debugging
|
693
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_search ...'
|
694
|
+
end
|
695
|
+
# verify the required parameter 'search_request' is set
|
696
|
+
if @api_client.config.client_side_validation && search_request.nil?
|
697
|
+
fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.get_conversations_search"
|
698
|
+
end
|
699
|
+
# resource path
|
700
|
+
local_var_path = '/conversation/conversations/search'
|
701
|
+
|
702
|
+
# query parameters
|
703
|
+
query_params = {}
|
704
|
+
|
705
|
+
# header parameters
|
706
|
+
header_params = {}
|
707
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
708
|
+
# HTTP header 'Accept' (if needed)
|
709
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
710
|
+
# HTTP header 'Content-Type'
|
711
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
712
|
+
|
713
|
+
# form parameters
|
714
|
+
form_params = {}
|
715
|
+
|
716
|
+
# http body (model)
|
717
|
+
post_body = @api_client.object_to_http_body(search_request)
|
718
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
719
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
720
|
+
:header_params => header_params,
|
721
|
+
:query_params => query_params,
|
722
|
+
:form_params => form_params,
|
723
|
+
:body => post_body,
|
724
|
+
:auth_names => auth_names,
|
725
|
+
:return_type => 'ConversationSearchResponse')
|
726
|
+
if @api_client.config.debugging
|
727
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversations_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
728
|
+
end
|
729
|
+
return data, status_code, headers
|
730
|
+
end
|
523
731
|
# Insert a canned message
|
524
732
|
# Insert a canned message
|
525
733
|
# @param canned_message Canned message
|
@@ -575,10 +783,121 @@ module UltracartClient
|
|
575
783
|
end
|
576
784
|
return data, status_code, headers
|
577
785
|
end
|
786
|
+
# Insert a department
|
787
|
+
# Insert a department
|
788
|
+
# @param department Department
|
789
|
+
# @param [Hash] opts the optional parameters
|
790
|
+
# @return [ConversationDepartmentResponse]
|
791
|
+
def insert_conversation_department(department, opts = {})
|
792
|
+
data, _status_code, _headers = insert_conversation_department_with_http_info(department, opts)
|
793
|
+
data
|
794
|
+
end
|
795
|
+
|
796
|
+
# Insert a department
|
797
|
+
# Insert a department
|
798
|
+
# @param department Department
|
799
|
+
# @param [Hash] opts the optional parameters
|
800
|
+
# @return [Array<(ConversationDepartmentResponse, Fixnum, Hash)>] ConversationDepartmentResponse data, response status code and response headers
|
801
|
+
def insert_conversation_department_with_http_info(department, opts = {})
|
802
|
+
if @api_client.config.debugging
|
803
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_department ...'
|
804
|
+
end
|
805
|
+
# verify the required parameter 'department' is set
|
806
|
+
if @api_client.config.client_side_validation && department.nil?
|
807
|
+
fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.insert_conversation_department"
|
808
|
+
end
|
809
|
+
# resource path
|
810
|
+
local_var_path = '/conversation/departments'
|
811
|
+
|
812
|
+
# query parameters
|
813
|
+
query_params = {}
|
814
|
+
|
815
|
+
# header parameters
|
816
|
+
header_params = {}
|
817
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
818
|
+
# HTTP header 'Accept' (if needed)
|
819
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
820
|
+
# HTTP header 'Content-Type'
|
821
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
822
|
+
|
823
|
+
# form parameters
|
824
|
+
form_params = {}
|
825
|
+
|
826
|
+
# http body (model)
|
827
|
+
post_body = @api_client.object_to_http_body(department)
|
828
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
829
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
830
|
+
:header_params => header_params,
|
831
|
+
:query_params => query_params,
|
832
|
+
:form_params => form_params,
|
833
|
+
:body => post_body,
|
834
|
+
:auth_names => auth_names,
|
835
|
+
:return_type => 'ConversationDepartmentResponse')
|
836
|
+
if @api_client.config.debugging
|
837
|
+
@api_client.config.logger.debug "API called: ConversationApi#insert_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
838
|
+
end
|
839
|
+
return data, status_code, headers
|
840
|
+
end
|
841
|
+
# Insert a engagement
|
842
|
+
# Insert a engagement
|
843
|
+
# @param engagement Engagement
|
844
|
+
# @param [Hash] opts the optional parameters
|
845
|
+
# @return [ConversationEngagementResponse]
|
846
|
+
def insert_conversation_engagement(engagement, opts = {})
|
847
|
+
data, _status_code, _headers = insert_conversation_engagement_with_http_info(engagement, opts)
|
848
|
+
data
|
849
|
+
end
|
850
|
+
|
851
|
+
# Insert a engagement
|
852
|
+
# Insert a engagement
|
853
|
+
# @param engagement Engagement
|
854
|
+
# @param [Hash] opts the optional parameters
|
855
|
+
# @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
|
856
|
+
def insert_conversation_engagement_with_http_info(engagement, opts = {})
|
857
|
+
if @api_client.config.debugging
|
858
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_engagement ...'
|
859
|
+
end
|
860
|
+
# verify the required parameter 'engagement' is set
|
861
|
+
if @api_client.config.client_side_validation && engagement.nil?
|
862
|
+
fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.insert_conversation_engagement"
|
863
|
+
end
|
864
|
+
# resource path
|
865
|
+
local_var_path = '/conversation/engagements'
|
866
|
+
|
867
|
+
# query parameters
|
868
|
+
query_params = {}
|
869
|
+
|
870
|
+
# header parameters
|
871
|
+
header_params = {}
|
872
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
873
|
+
# HTTP header 'Accept' (if needed)
|
874
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
875
|
+
# HTTP header 'Content-Type'
|
876
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
877
|
+
|
878
|
+
# form parameters
|
879
|
+
form_params = {}
|
880
|
+
|
881
|
+
# http body (model)
|
882
|
+
post_body = @api_client.object_to_http_body(engagement)
|
883
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
884
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
885
|
+
:header_params => header_params,
|
886
|
+
:query_params => query_params,
|
887
|
+
:form_params => form_params,
|
888
|
+
:body => post_body,
|
889
|
+
:auth_names => auth_names,
|
890
|
+
:return_type => 'ConversationEngagementResponse')
|
891
|
+
if @api_client.config.debugging
|
892
|
+
@api_client.config.logger.debug "API called: ConversationApi#insert_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
893
|
+
end
|
894
|
+
return data, status_code, headers
|
895
|
+
end
|
578
896
|
# Join a conversation
|
579
897
|
# Join a conversation
|
580
898
|
# @param conversation_uuid
|
581
899
|
# @param [Hash] opts the optional parameters
|
900
|
+
# @option opts [ConversationJoinRequest] :join_request Join request
|
582
901
|
# @return [nil]
|
583
902
|
def join_conversation(conversation_uuid, opts = {})
|
584
903
|
join_conversation_with_http_info(conversation_uuid, opts)
|
@@ -589,6 +908,7 @@ module UltracartClient
|
|
589
908
|
# Join a conversation
|
590
909
|
# @param conversation_uuid
|
591
910
|
# @param [Hash] opts the optional parameters
|
911
|
+
# @option opts [ConversationJoinRequest] :join_request Join request
|
592
912
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
593
913
|
def join_conversation_with_http_info(conversation_uuid, opts = {})
|
594
914
|
if @api_client.config.debugging
|
@@ -616,7 +936,7 @@ module UltracartClient
|
|
616
936
|
form_params = {}
|
617
937
|
|
618
938
|
# http body (model)
|
619
|
-
post_body =
|
939
|
+
post_body = @api_client.object_to_http_body(opts[:'join_request'])
|
620
940
|
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
621
941
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
622
942
|
:header_params => header_params,
|
@@ -908,6 +1228,128 @@ module UltracartClient
|
|
908
1228
|
end
|
909
1229
|
return data, status_code, headers
|
910
1230
|
end
|
1231
|
+
# Update a department
|
1232
|
+
# Update a department
|
1233
|
+
# @param conversation_department_oid
|
1234
|
+
# @param department Department
|
1235
|
+
# @param [Hash] opts the optional parameters
|
1236
|
+
# @return [ConversationDepartmentResponse]
|
1237
|
+
def update_conversation_department(conversation_department_oid, department, opts = {})
|
1238
|
+
data, _status_code, _headers = update_conversation_department_with_http_info(conversation_department_oid, department, opts)
|
1239
|
+
data
|
1240
|
+
end
|
1241
|
+
|
1242
|
+
# Update a department
|
1243
|
+
# Update a department
|
1244
|
+
# @param conversation_department_oid
|
1245
|
+
# @param department Department
|
1246
|
+
# @param [Hash] opts the optional parameters
|
1247
|
+
# @return [Array<(ConversationDepartmentResponse, Fixnum, Hash)>] ConversationDepartmentResponse data, response status code and response headers
|
1248
|
+
def update_conversation_department_with_http_info(conversation_department_oid, department, opts = {})
|
1249
|
+
if @api_client.config.debugging
|
1250
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_department ...'
|
1251
|
+
end
|
1252
|
+
# verify the required parameter 'conversation_department_oid' is set
|
1253
|
+
if @api_client.config.client_side_validation && conversation_department_oid.nil?
|
1254
|
+
fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.update_conversation_department"
|
1255
|
+
end
|
1256
|
+
# verify the required parameter 'department' is set
|
1257
|
+
if @api_client.config.client_side_validation && department.nil?
|
1258
|
+
fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.update_conversation_department"
|
1259
|
+
end
|
1260
|
+
# resource path
|
1261
|
+
local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', conversation_department_oid.to_s)
|
1262
|
+
|
1263
|
+
# query parameters
|
1264
|
+
query_params = {}
|
1265
|
+
|
1266
|
+
# header parameters
|
1267
|
+
header_params = {}
|
1268
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1269
|
+
# HTTP header 'Accept' (if needed)
|
1270
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1271
|
+
# HTTP header 'Content-Type'
|
1272
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1273
|
+
|
1274
|
+
# form parameters
|
1275
|
+
form_params = {}
|
1276
|
+
|
1277
|
+
# http body (model)
|
1278
|
+
post_body = @api_client.object_to_http_body(department)
|
1279
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1280
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1281
|
+
:header_params => header_params,
|
1282
|
+
:query_params => query_params,
|
1283
|
+
:form_params => form_params,
|
1284
|
+
:body => post_body,
|
1285
|
+
:auth_names => auth_names,
|
1286
|
+
:return_type => 'ConversationDepartmentResponse')
|
1287
|
+
if @api_client.config.debugging
|
1288
|
+
@api_client.config.logger.debug "API called: ConversationApi#update_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1289
|
+
end
|
1290
|
+
return data, status_code, headers
|
1291
|
+
end
|
1292
|
+
# Update a engagement
|
1293
|
+
# Update a engagement
|
1294
|
+
# @param conversation_engagement_oid
|
1295
|
+
# @param engagement Engagement
|
1296
|
+
# @param [Hash] opts the optional parameters
|
1297
|
+
# @return [ConversationEngagementResponse]
|
1298
|
+
def update_conversation_engagement(conversation_engagement_oid, engagement, opts = {})
|
1299
|
+
data, _status_code, _headers = update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts)
|
1300
|
+
data
|
1301
|
+
end
|
1302
|
+
|
1303
|
+
# Update a engagement
|
1304
|
+
# Update a engagement
|
1305
|
+
# @param conversation_engagement_oid
|
1306
|
+
# @param engagement Engagement
|
1307
|
+
# @param [Hash] opts the optional parameters
|
1308
|
+
# @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
|
1309
|
+
def update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts = {})
|
1310
|
+
if @api_client.config.debugging
|
1311
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_engagement ...'
|
1312
|
+
end
|
1313
|
+
# verify the required parameter 'conversation_engagement_oid' is set
|
1314
|
+
if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
|
1315
|
+
fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.update_conversation_engagement"
|
1316
|
+
end
|
1317
|
+
# verify the required parameter 'engagement' is set
|
1318
|
+
if @api_client.config.client_side_validation && engagement.nil?
|
1319
|
+
fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.update_conversation_engagement"
|
1320
|
+
end
|
1321
|
+
# resource path
|
1322
|
+
local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
|
1323
|
+
|
1324
|
+
# query parameters
|
1325
|
+
query_params = {}
|
1326
|
+
|
1327
|
+
# header parameters
|
1328
|
+
header_params = {}
|
1329
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1330
|
+
# HTTP header 'Accept' (if needed)
|
1331
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1332
|
+
# HTTP header 'Content-Type'
|
1333
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1334
|
+
|
1335
|
+
# form parameters
|
1336
|
+
form_params = {}
|
1337
|
+
|
1338
|
+
# http body (model)
|
1339
|
+
post_body = @api_client.object_to_http_body(engagement)
|
1340
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1341
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1342
|
+
:header_params => header_params,
|
1343
|
+
:query_params => query_params,
|
1344
|
+
:form_params => form_params,
|
1345
|
+
:body => post_body,
|
1346
|
+
:auth_names => auth_names,
|
1347
|
+
:return_type => 'ConversationEngagementResponse')
|
1348
|
+
if @api_client.config.debugging
|
1349
|
+
@api_client.config.logger.debug "API called: ConversationApi#update_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1350
|
+
end
|
1351
|
+
return data, status_code, headers
|
1352
|
+
end
|
911
1353
|
# Update status within the queue
|
912
1354
|
# Update status within the queue
|
913
1355
|
# @param queue_name
|